What is this?
Docsify turns your Markdown files into a documentation website: you write Markdown, and it becomes a site with no build process required.
Docsify turns your Markdown files into a documentation website: you write Markdown, and it becomes a site with no build process required.So is it a build tool that compiles my docs into HTML, or something that runs in the page?It renders your Markdown on the fly instead of pre-building HTML files, so there is nothing to compile — the site assembles itself when a visitor opens it.
It renders your Markdown on the fly instead of pre-building HTML files, so there is nothing to compile — the site assembles itself when a visitor opens it.How do I get a docs site up and running?Grab the ready-to-use Docsify Template and serve it with any static web server or GitHub Pages, or start from the quick start tutorial or a CodeSandbox example. There is also an official Docsify CLI.
Grab the ready-to-use Docsify Template and serve it with any static web server or GitHub Pages, or start from the quick start tutorial or a CodeSandbox example. There is also an official Docsify CLI.What do I need to have installed?Nothing but a browser for your docs site — Docsify loads from a CDN (UNPKG, jsDelivr or cdnjs). Node.js 20.11+ is only required to work on Docsify's own source code.
Nothing but a browser for your docs site — Docsify loads from a CDN (UNPKG, jsDelivr or cdnjs). Node.js 20.11+ is only required to work on Docsify's own source code.What does it offer out of the box?A smart full-text search plugin, multiple themes, a plugin API for custom behavior and emoji support — all kept simple and lightweight.
A smart full-text search plugin, multiple themes, a plugin API for custom behavior and emoji support — all kept simple and lightweight.Where can I see real sites built with Docsify?The awesome-docsify collection gathers a large set of showcase projects built with it.
The awesome-docsify collection gathers a large set of showcase projects built with it.What are similar projects?docz, fumadocs, jsdoc, zola, mdBook, NotionNext, react-styleguidist, tui.editor
docz, fumadocs, jsdoc, zola, mdBook, NotionNext, react-styleguidist, tui.editorWhich topics is it in?docs, documentation-tool, github-pages, full-text-search, themes, search, vue, documentation, plugin, markdown, npm, frontend
docs, documentation-tool, github-pages, full-text-search, themes, search, vue, documentation, plugin, markdown, npm, frontend