Skip to content

Commit

Permalink
Add mkdocs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
klntsky committed Nov 12, 2024
1 parent d73584d commit e2b9778
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
- [Module system](./modules.md)
- [Syntax](./syntax.md)
51 changes: 51 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
site_name: MetaPrompt Documentation

# Site description (optional)
site_description: "MetaPrompt is a template engine for LLM prompts with support for writing prompts with prompts "

# Site URL (optional, useful for SEO and deployment)
site_url: "https://docs.metaprompt-lang.org"

# Theme
theme:
name: material

markdown_extensions:
- toc:
permalink: true
- tables
- admonition
- codehilite

nav:
- Home: index.md
# - Getting Started:
# - Introduction: getting_started/introduction.md
# - Installation: getting_started/installation.md
# - Usage:
# - Basic Usage: usage/basic_usage.md
# - Advanced Features: usage/advanced_features.md
# - API Reference:
# - API Overview: api/api_overview.md
# - About:
# - License: about/license.md
# - Contributing: about/contributing.md

# Extra configuration for plugins (optional)
plugins:
- search # Default search plugin
# Uncomment below for more plugins (you'll need to install them separately)
# - mkdocs-mermaid2-plugin
# - mkdocs-awesome-pages-plugin

# extra_javascript:
# - javascripts/custom.js

# extra_css:
# - stylesheets/custom.css

site_dir: site

repo_url: https://github.com/promptware/metaprompt

docs_dir: docs

0 comments on commit e2b9778

Please sign in to comment.