mirror of
https://github.com/fastapi/sqlmodel.git
synced 2026-03-13 09:29:54 +08:00
👷 Upgrade build docs configs (#1047)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
0678615de5
commit
970492487a
93
mkdocs.yml
93
mkdocs.yml
@@ -25,16 +25,28 @@ theme:
|
||||
icon: material/lightbulb-outline
|
||||
name: Switch to system preference
|
||||
features:
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- content.tabs.link
|
||||
- navigation.indexes
|
||||
- content.tooltips
|
||||
- navigation.path
|
||||
- content.code.annotate
|
||||
- content.code.copy
|
||||
- content.code.select
|
||||
# - content.code.select
|
||||
- content.footnote.tooltips
|
||||
- content.tabs.link
|
||||
- content.tooltips
|
||||
- navigation.footer
|
||||
- navigation.indexes
|
||||
- navigation.instant
|
||||
- navigation.instant.prefetch
|
||||
- navigation.instant.preview
|
||||
- navigation.instant.progress
|
||||
- navigation.path
|
||||
# - navigation.tabs
|
||||
# - navigation.tabs.sticky
|
||||
- navigation.top
|
||||
- navigation.tracking
|
||||
- search.highlight
|
||||
- search.share
|
||||
- search.suggest
|
||||
- toc.follow
|
||||
|
||||
icon:
|
||||
repo: fontawesome/brands/github-alt
|
||||
logo: img/icon-white.svg
|
||||
@@ -42,11 +54,14 @@ theme:
|
||||
language: en
|
||||
repo_name: tiangolo/sqlmodel
|
||||
repo_url: https://github.com/tiangolo/sqlmodel
|
||||
edit_uri: ''
|
||||
plugins:
|
||||
search: null
|
||||
markdownextradata:
|
||||
data: ./data
|
||||
# Material for MkDocs
|
||||
search:
|
||||
social:
|
||||
# Other plugins
|
||||
macros:
|
||||
include_yaml:
|
||||
- sponsors: data/sponsors.yml
|
||||
|
||||
nav:
|
||||
- SQLModel: index.md
|
||||
@@ -113,33 +128,68 @@ nav:
|
||||
- release-notes.md
|
||||
|
||||
markdown_extensions:
|
||||
markdown.extensions.attr_list:
|
||||
markdown.extensions.tables:
|
||||
markdown.extensions.md_in_html:
|
||||
# Python Markdown
|
||||
abbr:
|
||||
attr_list:
|
||||
footnotes:
|
||||
md_in_html:
|
||||
tables:
|
||||
toc:
|
||||
permalink: true
|
||||
|
||||
# Python Markdown Extensions
|
||||
pymdownx.betterem:
|
||||
smart_enable: all
|
||||
pymdownx.caret:
|
||||
pymdownx.highlight:
|
||||
line_spans: __span
|
||||
pymdownx.inlinehilite:
|
||||
pymdownx.keys:
|
||||
pymdownx.mark:
|
||||
pymdownx.superfences:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
class: mermaid
|
||||
format: !!python/name:pymdownx.superfences.fence_code_format ''
|
||||
pymdownx.betterem:
|
||||
pymdownx.blocks.details:
|
||||
format: !!python/name:pymdownx.superfences.fence_code_format
|
||||
pymdownx.tilde:
|
||||
|
||||
# pymdownx blocks
|
||||
pymdownx.blocks.admonition:
|
||||
types:
|
||||
- note
|
||||
- info
|
||||
- tip
|
||||
- warning
|
||||
- attention
|
||||
- caution
|
||||
- danger
|
||||
- error
|
||||
- tip
|
||||
- hint
|
||||
- warning
|
||||
# Custom types
|
||||
- info
|
||||
pymdownx.blocks.details:
|
||||
pymdownx.blocks.tab:
|
||||
alternate_style: True
|
||||
|
||||
# Other extensions
|
||||
mdx_include:
|
||||
|
||||
extra:
|
||||
analytics:
|
||||
provider: google
|
||||
property: G-J8HVTT936W
|
||||
feedback:
|
||||
title: Was this page helpful?
|
||||
ratings:
|
||||
- icon: material/emoticon-happy-outline
|
||||
name: This page was helpful
|
||||
data: 1
|
||||
note: >-
|
||||
Thanks for your feedback!
|
||||
- icon: material/emoticon-sad-outline
|
||||
name: This page could be improved
|
||||
data: 0
|
||||
note: >-
|
||||
Thanks for your feedback!
|
||||
social:
|
||||
- icon: fontawesome/brands/github-alt
|
||||
link: https://github.com/tiangolo/sqlmodel
|
||||
@@ -161,3 +211,6 @@ extra_css:
|
||||
extra_javascript:
|
||||
- js/termynal.js
|
||||
- js/custom.js
|
||||
|
||||
hooks:
|
||||
- scripts/mkdocs_hooks.py
|
||||
|
||||
Reference in New Issue
Block a user