typer/mkdocs.yml
2019-12-31 22:14:18 +01:00

74 lines
2.2 KiB
YAML

site_name: Typer
site_description: Typer, build great CLIs. Easy to code. Based on Python type hints.
site_url: https://typer.tiangolo.com/
theme:
name: 'material'
palette:
primary: 'black'
accent: 'teal'
logo: 'img/icon-white.svg'
favicon: 'img/favicon.png'
repo_name: tiangolo/typer
repo_url: https://github.com/tiangolo/typer
edit_uri: ''
google_analytics:
- 'UA-155009830-1'
- 'auto'
nav:
- Typer: 'index.md'
- Features: 'features.md'
- Tutorial - User Guide:
- Tutorial - User Guide - Intro: 'tutorial/index.md'
- First Steps: 'tutorial/first-steps.md'
- CLI Options: 'tutorial/options.md'
- CLI Arguments: 'tutorial/arguments.md'
- Commands: 'tutorial/commands.md'
- CLI Parameter Types:
- CLI Parameter Types Intro: 'tutorial/parameter-types/index.md'
- Number: 'tutorial/parameter-types/number.md'
- UUID: 'tutorial/parameter-types/uuid.md'
- DateTime: 'tutorial/parameter-types/datetime.md'
- Enum - Choices: 'tutorial/parameter-types/enum.md'
- Path: 'tutorial/parameter-types/path.md'
- File: 'tutorial/parameter-types/file.md'
- Alternatives, Inspiration and Comparisons: 'alternatives.md'
- Help Typer - Get Help: 'help-typer.md'
- Development - Contributing: 'contributing.md'
- Release Notes: release-notes.md
markdown_extensions:
- toc:
permalink: true
- markdown.extensions.codehilite:
guess_lang: false
- markdown_include.include:
base_path: docs
- admonition
- codehilite
- extra
extra:
social:
- type: 'github'
link: 'https://github.com/tiangolo/typer'
- type: 'twitter'
link: 'https://twitter.com/tiangolo'
- type: 'linkedin'
link: 'https://www.linkedin.com/in/tiangolo'
- type: 'rss'
link: 'https://dev.to/tiangolo'
- type: 'medium'
link: 'https://medium.com/@tiangolo'
- type: 'globe'
link: 'https://tiangolo.com'
extra_css:
- 'css/termynal.css'
- 'css/custom.css'
extra_javascript:
- 'js/termynal.js'
- 'js/custom.js'