From e2b97783e54da679c0b04b5e01530f0e5893ac92 Mon Sep 17 00:00:00 2001 From: Vladimir Kalnitsky Date: Tue, 12 Nov 2024 20:13:41 +0400 Subject: [PATCH] Add mkdocs.yml --- doc/index.md | 1 + mkdocs.yml | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 mkdocs.yml diff --git a/doc/index.md b/doc/index.md index 81242d6..3d43da7 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1 +1,2 @@ - [Module system](./modules.md) +- [Syntax](./syntax.md) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..f3f9b38 --- /dev/null +++ b/mkdocs.yml @@ -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