# docpages > docpages builds a static documentation site from a folder of Markdown files in your Git repository. Write GitHub Flavored Markdown with syntax-highlighted code, Mermaid diagrams, math, footnotes, emoji, callouts, collapsible sections, responsive images, video and audio. docpages turns the folder structure into navigation and adds in-browser search, versions for main and every release, offline viewing, light and dark themes, custom styles and templates, and llms.txt with a Markdown copy of every page. Each link leads to the Markdown copy of a page of the documentation. llms-full.txt holds all of them in 1 file. ## Get started - [Introduction](index.md): docpages builds a static documentation site from a folder of Markdown files in your Git repository. Write GitHub Flavored Markdown with syntax-highlighted code, Mermaid diagrams, math, footnotes, emoji, callouts, collapsible sections, responsive images, video and audio. docpages turns the folder structure into navigation and adds in-browser search, versions for main and every release, offline viewing, light and dark themes, custom styles and templates, and llms.txt with a Markdown copy of every page. - [Quick start](get-started/quick-start.md): You need Go 1.27.4 or later, and a Git repository for your docs. - [Examples](get-started/examples.md): The repository has 2 example docs folders, each with a style of its own. Each is deployed as a site, and you can serve it from the root of a clone of the repository. ## Guide - [Layout](guide/layout.md): The layout of your docs folder is the navigation. - [Writing pages](guide/writing.md): Pages are GitHub Flavored Markdown. If a page reads well on GitHub, it reads well on the site. - [Images and video](guide/media.md): Embed images and videos as you would for GitHub. docpages copies each file that a page shows into the site, so the site works without the repository. - [Site settings](guide/site-settings.md): The front matter of docs/README.md sets up the whole site: - [Styling](guide/styling.md): Put style.css in the docs folder. Every page of every version loads it after the stylesheet of docpages. The site holds it minified, without comments and spaces, and -serve serves it as you wrote it. A mistake that a browser would skip, as an unknown property or a { without its }, fails the build. See Checks. - [Templates](guide/templates.md): To change the markup of the pages, as the links of the header and the footer, put templ files in the docs folder. The pages show templ DocpagesMain of these files, in place of the built-in page: - [Versions](guide/versions.md): The docs folder documents main, and each release shows the docs folder as it was at the release's Git tag. To turn releases on, set releases in the front matter of docs/README.md, with from as the oldest version that the site shows: - [Repository host](guide/repository-host.md): The pages link your repository: in the header, in the footer, as "View this page on GitHub" and wherever a page links a file that isn't a page. By default these are GitHub links. - [Deploy](guide/deploy.md): docpages -o site docs writes a static site. Upload site/ to any static host. ## Reference - [CLI](reference/cli.md): dir is the docs folder, the current folder by default. It must be inside a Git repository. - [Front matter](reference/front-matter.md): A key that docpages doesn't know fails the build. - [Output](reference/output.md): Every page links its Markdown copy as "Raw Markdown". The links in a copy lead to the other copies. - [Go library](reference/go-library.md): The package github.com/romshark/docpages builds the docs from Go, as for a site with pages of your own around them: - [Checks](reference/checks.md): A build stops at the mistakes below and names the file of each, and in Markdown and CSS its line, as docs/2-guide/1-layout.md:12:. A mistake in a release starts with its tag, as release v1.2.3:, and names the file at its place in the docs folder. -serve stops at them when it starts. A mistake that you make while it serves shows in the page until you fix it.