From e34711fff7443381fe4eef5fe3125d9e7e4422a2 Mon Sep 17 00:00:00 2001 From: Adcent Date: Wed, 20 Sep 2023 16:03:59 +0800 Subject: [PATCH] add a docsify start template --- docs/integration/docsify.md | 4 ++-- examples/docsify/.gitignore | 1 + examples/docsify/.nojekyll | 0 examples/docsify/README.md | 3 +++ examples/docsify/_navbar.md | 5 +++++ examples/docsify/documate.json | 5 +++++ examples/docsify/index.html | 25 +++++++++++++++++++++++++ examples/docsify/package.json | 12 ++++++++++++ examples/vitepress/package.json | 2 +- 9 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 examples/docsify/.gitignore create mode 100644 examples/docsify/.nojekyll create mode 100644 examples/docsify/README.md create mode 100644 examples/docsify/_navbar.md create mode 100644 examples/docsify/documate.json create mode 100644 examples/docsify/index.html create mode 100644 examples/docsify/package.json diff --git a/docs/integration/docsify.md b/docs/integration/docsify.md index de49d78..47f4b0d 100644 --- a/docs/integration/docsify.md +++ b/docs/integration/docsify.md @@ -73,7 +73,7 @@ pnpm install @documate/vanilla ::: -Them import it in your `index.js` file: +Then import it in your `index.js` file: ```js import '@documate/vanilla' @@ -95,7 +95,7 @@ Modify the Documate UI you added before to pass the endpoint to the `data-endpoi ```html - + ``` ## Run the Project diff --git a/examples/docsify/.gitignore b/examples/docsify/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/examples/docsify/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/examples/docsify/.nojekyll b/examples/docsify/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/examples/docsify/README.md b/examples/docsify/README.md new file mode 100644 index 0000000..ec8246f --- /dev/null +++ b/examples/docsify/README.md @@ -0,0 +1,3 @@ +# Documate Docsify Starter + +This is a template for creating a new Docsify site with Documate. Read [the guide](https://documate.site/integration/docsify) for more information. diff --git a/examples/docsify/_navbar.md b/examples/docsify/_navbar.md new file mode 100644 index 0000000..a3cd5c9 --- /dev/null +++ b/examples/docsify/_navbar.md @@ -0,0 +1,5 @@ + + + + Ask AI + diff --git a/examples/docsify/documate.json b/examples/docsify/documate.json new file mode 100644 index 0000000..b0e6746 --- /dev/null +++ b/examples/docsify/documate.json @@ -0,0 +1,5 @@ +{ + "root": ".", + "include": [ "**/*.md" ], + "backend": "" +} \ No newline at end of file diff --git a/examples/docsify/index.html b/examples/docsify/index.html new file mode 100644 index 0000000..abbeb80 --- /dev/null +++ b/examples/docsify/index.html @@ -0,0 +1,25 @@ + + + + + Documate Docsify Starter + + + + + + +
+ + + + + + + diff --git a/examples/docsify/package.json b/examples/docsify/package.json new file mode 100644 index 0000000..a7dc5bd --- /dev/null +++ b/examples/docsify/package.json @@ -0,0 +1,12 @@ +{ + "name": "documate-docsify-starter", + "version": "1.0.0", + "description": "A template for creating a new Docsify site with Documate", + "private": true, + "scripts": { + "documate:upload": "documate upload" + }, + "devDependencies": { + "@documate/documate": "^0.1.0" + } +} diff --git a/examples/vitepress/package.json b/examples/vitepress/package.json index d199c6c..e1ac95b 100644 --- a/examples/vitepress/package.json +++ b/examples/vitepress/package.json @@ -1,6 +1,6 @@ { "name": "documate-vitepress-starter", - "description": "A demo of how to integrate Documate into Vitepress site. You can also use this as a template to start a new project.", + "description": "A template for creating a new VitePress site with Documate", "version": "0.0.0", "private": true, "type": "module",