Skip to content

Commit 6f584de

Browse files
committed
docs: added docs for
- mcp server - LLM instructions
1 parent d72c464 commit 6f584de

10 files changed

+2509
-90
lines changed

docs/.vitepress/config.mts

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import {defineConfig} from 'vitepress'
2+
import {withMermaid} from "vitepress-plugin-mermaid";
23

3-
export default defineConfig({
4+
export default withMermaid({
45
ignoreDeadLinks: true,
56
title: "Context Generator Docs",
67
description: "Documentation for Context Generator for LLM",
@@ -13,7 +14,10 @@ export default defineConfig({
1314
nav: [
1415
{text: 'Docs', link: '/'},
1516
{text: 'GitHub', link: 'https://github.com/context-hub/generator'},
16-
{text: 'Json Schema', link: 'https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json'}
17+
{
18+
text: 'Json Schema',
19+
link: 'https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json'
20+
}
1721
],
1822

1923
sidebar: [
@@ -29,6 +33,7 @@ export default defineConfig({
2933
items: [
3034
{text: 'Installation', link: '/getting-started'},
3135
{text: 'Configuration', link: '/configuration'},
36+
{text: 'MCP Server', link: '/mcp-server'},
3237
{text: 'Command Reference', link: '/getting-started/command-reference'},
3338
{text: 'Environment Variables', link: '/environment-variables'},
3439
{text: 'IDE Integration', link: '/getting-started/ide-integration'},
@@ -63,6 +68,8 @@ export default defineConfig({
6368
{
6469
text: 'Advanced',
6570
items: [
71+
{text: 'Instructions (Examples)', link: '/advanced/instructions'},
72+
{text: 'Development steps', link: '/advanced/development-steps'},
6673
{text: 'Development with Context Generator', link: '/advanced/development-process'},
6774
{text: 'LLM Integration: Smart Context Requesting', link: '/advanced/smart-context-requesting'},
6875
],
@@ -76,5 +83,12 @@ export default defineConfig({
7683
socialLinks: [
7784
{icon: 'github', link: 'https://github.com/context-hub/docs'}
7885
]
79-
}
80-
})
86+
},
87+
mermaid: {
88+
// refer https://mermaid.js.org/config/setup/modules/mermaidAPI.html#mermaidapi-configuration-defaults for options
89+
},
90+
// optionally set additional config for plugin itself with MermaidPluginConfig
91+
mermaidPlugin: {
92+
class: "mermaid my-class", // set additional css classes for parent container
93+
},
94+
});

0 commit comments

Comments
 (0)