-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- 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
1 parent
09b9e2b
commit 1782d5e
Showing
8 changed files
with
367 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"tabWidth": 4 | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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
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. |
This file contains 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
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 |
Oops, something went wrong.