Skip to content

Commit

Permalink
Add Material for MkDocs config
Browse files Browse the repository at this point in the history
- Install mkdocs-material: https://squidfunk.github.io/mkdocs-material/
- Add mkdocs-material favicon
- Add separate .prettierrc for docs: requires four-space indentations
- Add Vercel config (vercel.json): https://vercel.com/docs/configuration
- Disable Git LFS for images for Vercel deployment: vercel/vercel#3716
  • Loading branch information
br3ndonland committed Aug 17, 2021
1 parent 09b9e2b commit 1782d5e
Show file tree
Hide file tree
Showing 8 changed files with 367 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
*.xls* filter=lfs diff=lfs merge=lfs -text
*.zip filter=lfs diff=lfs merge=lfs -text
*.doc* filter=lfs diff=lfs merge=lfs -text
*.jp*g filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text
# *.jp*g filter=lfs diff=lfs merge=lfs -text
# *.png filter=lfs diff=lfs merge=lfs -text
3 changes: 3 additions & 0 deletions docs/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"tabWidth": 4
}
Binary file added docs/assets/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

- `mkdocs new [dir-name]` - Create a new project.
- `mkdocs serve` - Start the live-reloading docs server.
- `mkdocs build` - Build the documentation site.
- `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
45 changes: 45 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
edit_uri: ""
markdown_extensions:
- admonition
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tasklist:
clickable_checkbox: false
custom_checkbox: true
- toc:
permalink: true
toc_depth: 3
nav:
- "index.md"
repo_name: br3ndonland/template-python
repo_url: https://github.com/br3ndonland/template-python
site_name: template-python docs
site_url: ""
theme:
favicon: assets/images/favicon.png
features:
- header.autohide
- navigation.instant
- navigation.top
font: false
icon:
logo: octicons/book-24
repo: octicons/mark-github-16
name: material
palette:
- media: "(prefers-color-scheme: dark)"
accent: cyan
primary: cyan
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
accent: cyan
primary: cyan
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
use_directory_urls: false
Loading

0 comments on commit 1782d5e

Please sign in to comment.