treefmt/mkdocs.yml
zimbatm c2762ce440
docs: be inspired by devenv
Generally clean things up and copy some config from devenv
2023-03-23 18:21:40 +01:00

81 lines
1.8 KiB
YAML

### Site metadata ###
site_name: treefmt
site_description: one CLI to format your repo
site_url: https://numtide.github.io/treefmt/
repo_name: 'numtide/treefmt'
repo_url: https://github.com/numtide/treefmt
edit_uri: edit/main/docs
copyright: Copyright © Numtide
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/numtide
name: Numtide on Github
- icon: fontawesome/brands/twitter
link: https://twitter.com/numtide
name: Numtide on Twitter
generator: false # hide the line "Made with Material for MkDocs"
### Build settings ###
extra_css:
- stylesheets/extra.css
markdown_extensions:
- tables
- admonition
- pymdownx.escapeall
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist
theme:
name: 'material'
palette:
- scheme: default
primary: teal
accent: orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: blue grey
accent: orange
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
# text: Montserrat
code: Roboto Mono
favicon: assets/favicon.png
logo: assets/logo.png
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- content.action.edit
- content.action.view
nav:
- Home: index.md
- QuickStart:
- About: quickstart.md
- Installation: installation.md
- Configuration: treefmt-configuration.md
- Usage: usage.md
- Formatters:
- About: index-formatters.md
- Formatter Specification: formatters-spec.md
- Known Formatters: formatters.md
- FAQ: faq.md
- Contributing: contributing.md