diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index aa7a0619f..59a35b6f6 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -19,6 +19,10 @@ validation: unrecognized_links: warn anchors: warn +# Preview controls +watch: + - snippets + # Theme configuration theme: name: material @@ -68,6 +72,7 @@ plugins: # Extensions markdown_extensions: + - abbr - admonition - attr_list - md_in_html @@ -80,7 +85,9 @@ markdown_extensions: line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - - pymdownx.snippets + - pymdownx.snippets: + auto_append: + - snippets/abbreviations.md - pymdownx.superfences - pymdownx.tasklist: custom_checkbox: true diff --git a/docs/snippets/abbreviations.md b/docs/snippets/abbreviations.md new file mode 100644 index 000000000..17d58c945 --- /dev/null +++ b/docs/snippets/abbreviations.md @@ -0,0 +1,7 @@ + + +*[addins]: Addins allow to extend Cake language with additional aliases +*[aliases]: Aliases are convenience methods that are easily accessible directly from a Cake build +*[CI]: Continuous Integration - The practice of integrating source code changes frequently and ensuring that the integrated codebase is in a workable state +*[linter]: A static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs +*[linters]: Static code analysis tools used to flag programming errors, bugs, stylistic errors and suspicious constructs