Thanks to visit codestin.com
Credit goes to github.com

Skip to content

🔨 Enable linenums in MkDocs Material during local live development to simplify highlighting code #9769

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

Merged
tiangolo merged 1 commit into from
Jun 30, 2023
Merged

🔨 Enable linenums in MkDocs Material during local live development to simplify highlighting code #9769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 docs/en/mkdocs.maybe-insiders.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Define this here and not in the main mkdocs.yml file because that one is auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, '../en/mkdocs.no-insiders.yml']
markdown_extensions:
pymdownx.highlight:
linenums: !ENV [LINENUMS, false]
20 changes: 10 additions & 10 deletions docs/en/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,24 +169,24 @@ nav:
- contributing.md
- release-notes.md
markdown_extensions:
- toc:
toc:
permalink: true
- markdown.extensions.codehilite:
markdown.extensions.codehilite:
guess_lang: false
- mdx_include:
mdx_include:
base_path: docs
- admonition
- codehilite
- extra
- pymdownx.superfences:
admonition:
codehilite:
extra:
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ''
- pymdownx.tabbed:
pymdownx.tabbed:
alternate_style: true
- attr_list
- md_in_html
attr_list:
md_in_html:
extra:
analytics:
provider: google
Expand Down
2 changes: 2 additions & 0 deletions scripts/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,8 @@ def live(
Takes an optional LANG argument with the name of the language to serve, by default
en.
"""
# Enable line numbers during local development to make it easier to highlight
os.environ["LINENUMS"] = "true"
if lang is None:
lang = "en"
lang_path: Path = docs_path / lang
Expand Down