dream2nix/docs/mkdocs.yml
2024-06-11 22:30:38 +02:00

72 lines
1.7 KiB
YAML

site_name: Dream2Nix
docs_dir: "src"
site_url: "https://nix-community.github.io/dream2nix"
site_dir: !ENV out
plugins:
- search
hooks:
- hooks/render_options.py
extra_css:
- style.css
nav:
- "Home": index.md
- "Getting Started": gettingstarted.md
- Concepts:
- "Modules": modules.md
- "Overriding Dependencies": overrides.md
- Examples:
- "👉 example repository": https://github.com/nix-community/dream2nix/tree/main/examples/repo-with-packages
- "👉 example repository using flakes": https://github.com/nix-community/dream2nix/tree/main/examples/repo-with-packages-flake)
- "👉 example packages": https://github.com/nix-community/dream2nix/tree/main/examples/packages)
- Reference:
- "pip": reference/pip/index.md
markdown_extensions:
- tables
- admonition
- pymdownx.escapeall
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tasklist
- pymdownx.details
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
theme:
name: material
favicon: favicon.png
logo: favicon.png
features:
- search.suggest
- search.highlight
- instant
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.tracking
- navigation.path
- navigation.top
- toc.follow
- content.code.annotate
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/nix-community/dream2nix
name: Dream2nix on Github
- icon: fontawesome/solid/comments
link: https://matrix.to/#/#dream2nix:nixos.org
name: Dream2nix Matrix Channel