Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

✨ Set up and enable Material for MkDocs Insiders for the docs #2325

Merged
merged 6 commits into from
Nov 8, 2020
Merged

✨ Set up and enable Material for MkDocs Insiders for the docs #2325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
18dcae0
⬆️ Upgrade Material for MkDocs
tiangolo Nov 8, 2020
a21deea
⬆️ Install Material for MkDocs Insiders on CI
tiangolo Nov 8, 2020
96cb6f2
🔧 Update MkDocs configs to use Material for MkDocs Insiders
tiangolo Nov 8, 2020
891577a
✨ Use the lightbulb because it looks nice 💡
tiangolo Nov 8, 2020
c23e282
💚 Fix GitHub Action workflow syntax for building docs
tiangolo Nov 8, 2020
7e7c937
🐛 Fix GitHub Actions workflow syntax, strike one ⚾
tiangolo Nov 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ jobs:
run: python3.7 -m pip install flit
- name: Install docs extras
run: python3.7 -m flit install --extras doc
- name: Install Material for MkDocs Insiders
if: github.repository == 'tiangolo/fastapi'
run: pip install git+https://${{ secrets.ACTIONS_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
- name: Build Docs
run: python3.7 ./scripts/docs.py build-all
- name: Zip docs
Expand Down
14 changes: 13 additions & 1 deletion docs/en/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/es/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/es/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/fr/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/fr/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/it/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/it/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/ja/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/ja/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/ko/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/ko/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/pt/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/pt/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/ru/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/ru/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/tr/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/tr/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/uk/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/uk/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
14 changes: 13 additions & 1 deletion docs/zh/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/zh/
theme:
name: material
palette:
scheme: preference
- scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
icon:
repo: fontawesome/brands/github-alt
logo: https://fastapi.tiangolo.com/img/icon-white.svg
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ test = [
]
doc = [
"mkdocs >=1.1.2,<2.0.0",
"mkdocs-material >=5.5.0,<6.0.0",
"mkdocs-material >=6.1.4,<7.0.0",
"markdown-include >=0.5.1,<0.6.0",
"mkdocs-markdownextradata-plugin >=0.1.7,<0.2.0",
"typer >=0.3.0,<0.4.0",
Expand Down