Last active
May 25, 2018 01:50
-
-
Save charlesreid1/f0fe26db445e6833361e6cc235069996 to your computer and use it in GitHub Desktop.
Sample mkdocs.yml for mkdocs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
site_name: your-cool-site | |
site_url: <url-for-your-docs> | |
repo_name: <repo-owner>/<repo-name> | |
repo_url: https://github.com/<repo-owner>/<repo-name> | |
edit_uri: "" | |
# give a title for each page | |
pages: | |
- 'Index' : 'index.md' | |
# etc... | |
copyright: 'Copyright © 2018 Nobody' | |
# change directory names here | |
docs_dir: docs | |
site_dir: site | |
theme: | |
# the next 2 lines are required to use the DIB version | |
name: null | |
custom_dir: 'mkdocs-material-dib/material' | |
# pretty colors! see https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors | |
palette: | |
primary: 'blue' | |
accent: 'blue' | |
# fun logos! see https://material.io/icons/ | |
logo: | |
icon: 'dns' | |
# any google font will do https://fonts.google.com/ | |
font: | |
text: 'Roboto' | |
code: 'Roboto Mono' | |
# this will add docs/css/custom.css to all your docs | |
extra_css: | |
- css/custom.css |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment