Skip to content

Commit

Permalink
Enable the 'admonitions' Markdown extension for Mkdocs.
Browse files Browse the repository at this point in the history
The admonitions extension to Python-Markdown allows you to include
rST-style "admonitions" to Markdown documents, for instance,

    !!! note
        Here's an important note to keep in mind!

In general, the current documentation uses bold text to try to achieve
the same effect, which is a bit harder to notice and makes it difficult
to differentiate between "here's something useful to know" versus "here
there be dragons".
  • Loading branch information
kernelmethod committed Nov 30, 2022
1 parent 3a11861 commit da024a7
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) 2
plugins:
- render_swagger

markdown_extensions:
- markdown.extensions.admonition

extra_javascript:
- assets/js/swagger-ui-bundle.js

Expand Down

0 comments on commit da024a7

Please sign in to comment.