diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 4aadad0..a1636dc 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -55,6 +55,12 @@ export default defineConfig({ { text: 'Start with Native JS', link: '/getting-started/vanilla-js' } ] }, + { + text: 'Integration', + items: [ + { text: 'Integration to Docsify', link: '/integration/docsify' }, + ] + }, { text: 'Reference', items: [ diff --git a/docs/developments/docsify.md b/docs/developments/docsify.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 3994993..c82fdb2 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -14,10 +14,13 @@ Please choose a framework below to get started: - [General Vue Project](/getting-started/general-vue) - [Vanilla JS](/getting-started/vanilla-js) +Documate can also be manually integrated to other library or frameworks. + +- [Docsify](/integration/docsify) + The following frameworks are coming soon: - Docusaurus -- Docsify - Vuepress - Docus - Nextra diff --git a/docs/integration/docsify.md b/docs/integration/docsify.md new file mode 100644 index 0000000..e907e12 --- /dev/null +++ b/docs/integration/docsify.md @@ -0,0 +1,17 @@ +# Integration to Docsify + +It's very easy to integrate Documate into Docsify. You just need to follow the [Native JavaScript Startup](/getting-started/vanilla-js) guide to import js and provide a button with the ID `ask-ai` in your doc's `index.html` page. + +```html + +... + +``` + +You can place the button anywhere you like, but the most convenient way is to [enable the NavBar](https://docsify.js.org/#/configuration?id=loadnavbar) and then place the button on the NavBar. + +There is an [online Example](https://spritejs.vercel.app/#/). + + + +