mirror of
https://github.com/mkdocs/mkdocs.git
synced 2026-03-27 09:58:31 +07:00
Enable <details> admonitions and nested codeblocks
This commit is contained in:
@@ -164,38 +164,38 @@ And the conversion flag `!q` is available, to percent-encode the field:
|
||||
|
||||
* `{path!q}`, e.g. `foo%2Fbar.md`
|
||||
|
||||
Here are some suggested configurations that can be useful:
|
||||
|
||||
GitHub Wiki:
|
||||
(e.g. `https://github.com/project/repo/wiki/foo/bar/_edit`)
|
||||
|
||||
```yaml
|
||||
repo_url: 'https://github.com/project/repo/wiki'
|
||||
edit_uri_template: '{path_noext}/_edit'
|
||||
```
|
||||
|
||||
BitBucket editor:
|
||||
(e.g. `https://bitbucket.org/project/repo/src/master/docs/foo/bar.md?mode=edit`)
|
||||
|
||||
```yaml
|
||||
repo_url: 'https://bitbucket.org/project/repo/'
|
||||
edit_uri_template: 'src/master/docs/{path}?mode=edit'
|
||||
```
|
||||
|
||||
GitLab Static Site Editor:
|
||||
(e.g. `https://gitlab.com/project/repo/-/sse/master/docs%2Ffoo%2bar.md`)
|
||||
|
||||
```yaml
|
||||
repo_url: 'https://gitlab.com/project/repo'
|
||||
edit_uri_template: '-/sse/master/docs%2F{path!q}'
|
||||
```
|
||||
|
||||
GitLab Web IDE:
|
||||
(e.g. `https://gitlab.com/-/ide/project/repo/edit/master/-/docs/foo/bar.md`)
|
||||
|
||||
```yaml
|
||||
edit_uri_template: 'https://gitlab.com/-/ide/project/repo/edit/master/-/docs/{path}'
|
||||
```
|
||||
>? NOTE: **Suggested useful configurations:**
|
||||
>
|
||||
> * GitHub Wiki:
|
||||
> (e.g. `https://github.com/project/repo/wiki/foo/bar/_edit`)
|
||||
>
|
||||
> ```yaml
|
||||
> repo_url: 'https://github.com/project/repo/wiki'
|
||||
> edit_uri_template: '{path_noext}/_edit'
|
||||
> ```
|
||||
>
|
||||
> * BitBucket editor:
|
||||
> (e.g. `https://bitbucket.org/project/repo/src/master/docs/foo/bar.md?mode=edit`)
|
||||
>
|
||||
> ```yaml
|
||||
> repo_url: 'https://bitbucket.org/project/repo/'
|
||||
> edit_uri_template: 'src/master/docs/{path}?mode=edit'
|
||||
> ```
|
||||
>
|
||||
> * GitLab Static Site Editor:
|
||||
> (e.g. `https://gitlab.com/project/repo/-/sse/master/docs%2Ffoo%2bar.md`)
|
||||
>
|
||||
> ```yaml
|
||||
> repo_url: 'https://gitlab.com/project/repo'
|
||||
> edit_uri_template: '-/sse/master/docs%2F{path!q}'
|
||||
> ```
|
||||
>
|
||||
> * GitLab Web IDE:
|
||||
> (e.g. `https://gitlab.com/-/ide/project/repo/edit/master/-/docs/foo/bar.md`)
|
||||
>
|
||||
> ```yaml
|
||||
> edit_uri_template: 'https://gitlab.com/-/ide/project/repo/edit/master/-/docs/{path}'
|
||||
> ```
|
||||
|
||||
**default**: `null`
|
||||
|
||||
@@ -599,20 +599,22 @@ def on_page_markdown(markdown, **kwargs):
|
||||
return markdown.replace('a', 'z')
|
||||
```
|
||||
|
||||
Advanced example that produces warnings based on the Markdown content (and warnings are fatal in [strict](#strict) mode):
|
||||
|
||||
```python
|
||||
import logging, re
|
||||
import mkdocs.plugins
|
||||
|
||||
log = logging.getLogger('mkdocs')
|
||||
|
||||
@mkdocs.plugins.event_priority(-50)
|
||||
def on_page_markdown(markdown, page, **kwargs):
|
||||
path = page.file.src_uri
|
||||
for m in re.finditer(r'\bhttp://[^) ]+', markdown):
|
||||
log.warning(f"Documentation file '{path}' contains a non-HTTPS link: {m[0]}")
|
||||
```
|
||||
>? EXAMPLE: **Advanced example:**
|
||||
>
|
||||
> This produces warnings based on the Markdown content (and warnings are fatal in [strict](#strict) mode):
|
||||
>
|
||||
> ```python
|
||||
> import logging, re
|
||||
> import mkdocs.plugins
|
||||
>
|
||||
> log = logging.getLogger('mkdocs')
|
||||
>
|
||||
> @mkdocs.plugins.event_priority(-50)
|
||||
> def on_page_markdown(markdown, page, **kwargs):
|
||||
> path = page.file.src_uri
|
||||
> for m in re.finditer(r'\bhttp://[^) ]+', markdown):
|
||||
> log.warning(f"Documentation file '{path}' contains a non-HTTPS link: {m[0]}")
|
||||
> ```
|
||||
|
||||
This does not enable any new abilities compared to [plugins][], it only simplifies one-off usages, as these don't need to be *installed* like plugins do.
|
||||
|
||||
|
||||
@@ -33,7 +33,10 @@ markdown_extensions:
|
||||
permalink:
|
||||
- attr_list
|
||||
- def_list
|
||||
- pymdownx.highlight:
|
||||
use_pygments: false
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences
|
||||
- callouts
|
||||
- mdx_gh_links:
|
||||
user: mkdocs
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
click==7.0
|
||||
Jinja2==2.11.1
|
||||
markupsafe==2.0.1
|
||||
Markdown==3.3
|
||||
Markdown==3.3.3
|
||||
PyYAML==5.1
|
||||
watchdog==2.0.0
|
||||
ghp-import==1.0
|
||||
@@ -14,7 +14,7 @@ babel==2.9.0
|
||||
|
||||
colorama==0.4; platform_system == 'Windows'
|
||||
mdx_gh_links==0.2
|
||||
markdown-callouts==0.2
|
||||
markdown-callouts==0.3.0
|
||||
mkdocs-literate-nav==0.5.0
|
||||
mkdocs-redirects==1.0.1
|
||||
pymdown-extensions==8.0.1
|
||||
|
||||
@@ -14,7 +14,7 @@ babel>=2.9.0
|
||||
|
||||
colorama>=0.4; platform_system == 'Windows'
|
||||
mdx_gh_links>=0.2
|
||||
markdown-callouts>=0.2
|
||||
markdown-callouts>=0.3.0
|
||||
mkdocs-literate-nav>=0.5.0
|
||||
mkdocs-redirects>=1.0.1
|
||||
pymdown-extensions>=8.0.1
|
||||
|
||||
Reference in New Issue
Block a user