folderdocs¶

iNote

This site is the template's demo and its documentation at the same time. Every page is a plain .md file inside docs/: there is no HTML to write or maintain.

You write Markdown and create folders; folderdocs turns them into a fast, static documentation site: sidebar menu, search, breadcrumbs, light and dark themes, admonitions and syntax highlighting. Every page is its own HTML file with a clean URL, so search engines can index it, and it works on any static hosting.

Pick the tile that best describes your situation:

I want to use the template.
Install it and run it locally. I want to write content.
Folders, menu and Markdown. I want it to look like my project.
Name, logo, colors and language. I want to publish it.
GitHub Pages and other hosts.

What's included¶

Automatic menu: each folder is a section and each .md a page. No lists to maintain.
One HTML page per Markdown file, with clean URLs, titles, descriptions, canonical links, a sitemap and breadcrumb data for search engines.
Readable without JavaScript; the script only adds search, the theme switch, the mobile menu and copy buttons.
Search in the sidebar (shortcut: /), built from an index generated at build time.
Light and dark themes, remembered between visits, and a mobile-friendly layout.
Admonitions, tables, highlighted code with a copy button, and relative links between pages that the build checks for you.
Multilingual: one documentation folder per language, with a language switcher and hreflang links.

Before you choose it¶

folderdocs generates static pages with one command (npm run build), and GitHub Pages runs it for you. Good URLs and metadata make your pages indexable, but they don't decide your ranking. Read SEO and limitations for what to expect, and the comparison with other tools.