Skip to content

Commit

Permalink
Fix highlighting in the docs (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
kgaughan authored Sep 21, 2024
1 parent 3c6b1b7 commit dce513c
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you want to use an explicitly named configuration file, you can pass this wit

Here is an example file:

```toml
```toml title="mercury.toml"
name = "My Planet!"
url = "https://example.com/"
owner = "Jane Doe"
Expand Down
2 changes: 1 addition & 1 deletion docs/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Here's an example of both being used:

A theme directory must also contain a `theme.toml` file. This contains metadata about the theme (currently just its name, which is given in the `name` field) and optionally a [bill of materials] listing the files to be copied across, each entry in which is introduced with `[[bom]]`. Here's an example file:

```toml
```toml title="theme.toml"
name = "Community"

[[bom]]
Expand Down
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,18 @@ theme:
name: material

markdown_extensions:
pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
pymdownx.inlinehilite: {}
pymdownx.snippets: {}
pymdownx.superfences: {}
admonition: {}
attr_list: {}

nav:
- index.md
- configuration.md
- themes.md
- architecture.md
22 changes: 11 additions & 11 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# This file was autogenerated by uv via the following command:
# uv pip compile requirements.in
babel==2.15.0
babel==2.16.0
# via mkdocs-material
bracex==2.5
# via wcmatch
certifi==2024.7.4
certifi==2024.8.30
# via requests
charset-normalizer==3.3.2
# via requests
Expand All @@ -14,13 +14,13 @@ colorama==0.4.6
# via mkdocs-material
ghp-import==2.1.0
# via mkdocs
idna==3.7
idna==3.10
# via requests
jinja2==3.1.4
# via
# mkdocs
# mkdocs-material
markdown==3.6
markdown==3.7
# via
# mkdocs
# mkdocs-material
Expand All @@ -33,7 +33,7 @@ mergedeep==1.3.4
# via
# mkdocs
# mkdocs-get-deps
mkdocs==1.6.0
mkdocs==1.6.1
# via
# -r requirements.in
# mkdocs-awesome-pages-plugin
Expand All @@ -42,19 +42,19 @@ mkdocs-awesome-pages-plugin==2.9.3
# via -r requirements.in
mkdocs-get-deps==0.2.0
# via mkdocs
mkdocs-material==9.5.31
mkdocs-material==9.5.36
# via -r requirements.in
mkdocs-material-extensions==1.3.1
# via mkdocs-material
natsort==8.4.0
# via mkdocs-awesome-pages-plugin
packaging==24.1
# via mkdocs
paginate==0.5.6
paginate==0.5.7
# via mkdocs-material
pathspec==0.12.1
# via mkdocs
platformdirs==4.2.2
platformdirs==4.3.6
# via mkdocs-get-deps
pygments==2.18.0
# via mkdocs-material
Expand All @@ -70,15 +70,15 @@ pyyaml==6.0.2
# pyyaml-env-tag
pyyaml-env-tag==0.1
# via mkdocs
regex==2024.7.24
regex==2024.9.11
# via mkdocs-material
requests==2.32.3
# via mkdocs-material
six==1.16.0
# via python-dateutil
urllib3==2.2.2
urllib3==2.2.3
# via requests
watchdog==4.0.1
watchdog==5.0.2
# via mkdocs
wcmatch==9.0
# via mkdocs-awesome-pages-plugin

0 comments on commit dce513c

Please sign in to comment.