The foundation for your documentation.
A documentation system built for Nuxt. Write in Markdown, keep your content in your app, and build on IPEX and Akaza UI.
Built for the way you document.
- Your content. Your project.
Markdown, navigation, and landing page values live together in your app. The layer takes care of the reading experience.
apps/docs/content/ index.yml getting-started/ introduction.md configuration.md- One layer to get started.
Extend Indocio from a Nuxt app. Override its components and layouts with Nuxt's file conventions.
export default defineNuxtConfig({ extends: ['@igrislabs/indocio'], })- Ready for more languages.
Enable i18n when you need it. Keep each translation in its own content folder.
content/ en/index.yml cn/index.yml fr/index.yml- IPEX, all the way through.
Shared tokens, coordinated components, and light and dark themes. Akaza UI handles the headless interactions.
<UiButton>Get started</UiButton> <UiTabs :items="items" />- Markdown with room to grow.
Headings, code blocks, callouts, and Vue components belong in the same document. Add your own when you need them.
::note{title="A useful detail"} Write the detail in Markdown. ::
See the reading experience.
This preview renders the actual introduction from this documentation app. Open a page or inspect the layer configuration.
Introduction
A documentation foundation built with Nuxt Content, IPEX, and Akaza UI.
Welcome to Indocio
Write your documentation in Markdown. Indocio provides the navigation, page layout, table of contents, search, and theme controls around your content.
Built on IPEX
The interface uses IPEX's design tokens and components, with Akaza UI providing the headless primitives. UI components are available with the Ui prefix, such as UiButton and UiTabs.
Write in Markdown
Nuxt Content renders headings, lists, tables, and code blocks. Indocio includes IPEX's prose styles and callouts for Markdown usage.
export default defineNuxtConfig({
extends: ['@igrislabs/indocio'],
})
Next steps
Read Configuration to configure the landing page and enable translated documentation.
Read Code tabs to group related files or alternate implementations inside Markdown.
Browse Markdown components in the sidebar for Callouts, Tabs, Steps, and the other Markdown components.