From eb9cc378efd865b9c72cc07c06d6cd68d05d5de7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Tue, 24 Dec 2019 14:01:30 +0100 Subject: [PATCH] :wrench: Add MkDocs config --- mkdocs.yml | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..8797a99 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,55 @@ +site_name: Typer +site_description: Typer, create easy to use command line applications. With code easy to write. +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/intro.md' + - First Steps: 'tutorial/first-steps.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'