Example Documentation Site

This sample site mixes two documentation sources:

  • Markdown files that live directly in the docs tree and do not use front matter.
  • Pages extracted from source code comments and doc blocks.

Use it to demonstrate a realistic starter setup for a project docs site:

  • getting-started.md is a plain Markdown page.
  • guides/ shows nested sections and custom ordering with .nav.yml.
  • src/extracted.py is converted into a rendered docs page during the build.

In this article