diff --git a/Dockerfile b/Dockerfile index 5c5d8cb..4fbea23 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,7 +7,7 @@ FROM minidocks/weasyprint AS weasyprint FROM $base_image AS latest LABEL maintainer="Martin Hasoň " -ARG mkdocs_version=1.3.1 +ARG mkdocs_version=1.4.2 RUN apk add py3-regex py3-pynacl py3-ruamel.yaml && pip install \ mkdocs==$mkdocs_version \ @@ -38,6 +38,7 @@ RUN apk add py3-regex py3-pynacl py3-ruamel.yaml && pip install \ mkdocs-simple-hooks \ mkdocs-redirects \ mkdocs-versioning \ + mkdocs-with-confluence \ mkdocstrings \ \ mkdocs-alabaster \ @@ -47,6 +48,8 @@ RUN apk add py3-regex py3-pynacl py3-ruamel.yaml && pip install \ mkdocs-material \ mkdocs-rtd-dropdown \ \ + neoteroi-mkdocs \ + \ markdown-include \ pygments \ pymdown-extensions \ diff --git a/README.md b/README.md index c677136..3772d30 100644 --- a/README.md +++ b/README.md @@ -13,83 +13,87 @@ Installed extensions ### Themes -- [Material Design theme](https://squidfunk.github.io/mkdocs-material/) usings - Google’s Material Design guidelines. -- [Alabaster theme](https://mkdocs-alabaster.ale.sh/) is a visually (c)lean, - responsive, configurable theme. -- [Ivory](https://github.com/daizutabi/mkdocs-ivory) -- [KPN Theme](https://kpn.github.io/mkdocs-kpn-theme/) -- [ReadTheDocs Dropdown theme](http://readthedocs.sheets.ch/) with collapsing - menu support. +- [Material Design theme](https://squidfunk.github.io/mkdocs-material/) usings + Google’s Material Design guidelines. +- [Alabaster theme](https://mkdocs-alabaster.ale.sh/) is a visually (c)lean, + responsive, configurable theme. +- [Ivory](https://github.com/daizutabi/mkdocs-ivory) +- [KPN Theme](https://kpn.github.io/mkdocs-kpn-theme/) +- [ReadTheDocs Dropdown theme](http://readthedocs.sheets.ch/) with collapsing + menu support. ### Plugins -- [Absolute to relative - link](https://github.com/sander76/mkdocs-abs-rel-plugin) -- [Add number](https://github.com/ignorantshr/mkdocs-add-number-plugin) plugin - to automatically number the headings (h1-h6) in each markdown page and the - nav. -- [Autolinks](https://github.com/midnightprioriem/mkdocs-autolinks-plugin/) - simplifies relative linking between documents. -- [Autorefs](https://github.com/mkdocstrings/autorefs) automatically link - across pages. -- [Awesome Pages - plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) allows - you to customize how your pages show up the navigation of your MkDocs - without having to configure the full structure in your `mkdocs.yml`. -- [Exclude](https://github.com/apenwarr/mkdocs-exclude) allows you to exclude - files from your input using unix-style wildcards (globs) or regular - expressions (regexes). -- [Git authors](https://github.com/timvink/mkdocs-git-authors-plugin) -- [Git committers](https://github.com/byrnereese/mkdocs-git-committers-plugin) -- [Git revision - date](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) -- [Merge plugin](https://github.com/ovasquez/mkdocs-merge) allows you to merge - the source of multiple MkDocs sites into a single one converting each of the - specified sites to a sub-site of the master site. -- [Enumerate - headings](https://github.com/timvink/mkdocs-enumerate-headings-plugin) will - enumerate the headings (h1-h6) across site pages. -- [Img2Fig](https://github.com/stuebersystems/mkdocs-img2fig-plugin) converts - `` to `
`. -- [Macros](https://github.com/fralau/mkdocs_macros_plugin) transforms the - markdown pages into jinja2 templates that use variables, calls to macros and - custom filters. -- [Markdown extra - data](https://github.com/rosscdh/mkdocs-markdownextradata-plugin) injects - the mkdocs.yml extra variables into the markdown template. -- [Minify](https://github.com/byrnereese/mkdocs-minify-plugin) to minify HTML - and/or JS files prior to being written to disk. -- [Mkdocstrings](https://mkdocstrings.github.io/) automatic documentation from - sources. -- [Monorepo](https://github.com/spotify/mkdocs-monorepo-plugin) Build multiple - documentation in a single Mkdocs. Designed for large codebases. -- [Multirepo](https://github.com/jdoiro3/mkdocs-multirepo-plugin) Build documentation in multiple repos into one site. -- [Pymdownx Material - Extras](https://github.com/facelessuser/mkdocs_pymdownx_material_extras) -- [Safe text](https://github.com/raimon49/mkdocs-safe-text-plugin) for safe - text editing with MKDocs. -- [Simple hooks](https://github.com/aklajnert/mkdocs-simple-hooks) to define - your own hooks for mkdocs, without having to create a new package. -- [Redirects](https://github.com/datarobot/mkdocs-redirects) to create page - redirects (e.g. for moved/renamed pages). -- [Versioning](https://github.com/zayd62/mkdocs-versioning) +- [Absolute to relative link](https://github.com/sander76/mkdocs-abs-rel-plugin) +- [Add number](https://github.com/ignorantshr/mkdocs-add-number-plugin) plugin + to automatically number the headings (h1-h6) in each markdown page and the + nav. +- [Autolinks](https://github.com/midnightprioriem/mkdocs-autolinks-plugin/) + simplifies relative linking between documents. +- [Autorefs](https://github.com/mkdocstrings/autorefs) automatically link across + pages. +- [Awesome Pages + plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) allows you + to customize how your pages show up the navigation of your MkDocs without + having to configure the full structure in your `mkdocs.yml`. +- [Exclude](https://github.com/apenwarr/mkdocs-exclude) allows you to exclude + files from your input using unix-style wildcards (globs) or regular + expressions (regexes). +- [Git authors](https://github.com/timvink/mkdocs-git-authors-plugin) +- [Git committers](https://github.com/byrnereese/mkdocs-git-committers-plugin) +- [Git revision + date](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) +- [Merge plugin](https://github.com/ovasquez/mkdocs-merge) allows you to merge + the source of multiple MkDocs sites into a single one converting each of the + specified sites to a sub-site of the master site. +- [Enumerate + headings](https://github.com/timvink/mkdocs-enumerate-headings-plugin) will + enumerate the headings (h1-h6) across site pages. +- [Img2Fig](https://github.com/stuebersystems/mkdocs-img2fig-plugin) converts + `` to `
`. +- [Macros](https://github.com/fralau/mkdocs_macros_plugin) transforms the + markdown pages into jinja2 templates that use variables, calls to macros and + custom filters. +- [Markdown extra + data](https://github.com/rosscdh/mkdocs-markdownextradata-plugin) injects the + mkdocs.yml extra variables into the markdown template. +- [Minify](https://github.com/byrnereese/mkdocs-minify-plugin) to minify HTML + and/or JS files prior to being written to disk. +- [Mkdocstrings](https://mkdocstrings.github.io/) automatic documentation from + sources. +- [Mkdocs with + Confluence](https://github.com/pawelsikora/mkdocs-with-confluence/) Plugin for + uploading markdown documentation to Confluence via Confluence REST API +- [Monorepo](https://github.com/spotify/mkdocs-monorepo-plugin) Build multiple + documentation in a single Mkdocs. Designed for large codebases. +- [Multirepo](https://github.com/jdoiro3/mkdocs-multirepo-plugin) Build + documentation in multiple repos into one site. +- [Neoterot plugins](https://www.neoteroi.dev/mkdocs-plugins/) +- [Pymdownx Material + Extras](https://github.com/facelessuser/mkdocs_pymdownx_material_extras) +- [Safe text](https://github.com/raimon49/mkdocs-safe-text-plugin) for safe text + editing with MKDocs. +- [Simple hooks](https://github.com/aklajnert/mkdocs-simple-hooks) to define + your own hooks for mkdocs, without having to create a new package. +- [Redirects](https://github.com/datarobot/mkdocs-redirects) to create page + redirects (e.g. for moved/renamed pages). +- [Versioning](https://github.com/zayd62/mkdocs-versioning) ##### Only in 1-pdf and 1.1-pdf tags -- [PDF export](https://github.com/zhaoterryy/mkdocs-pdf-export-plugin) will - export all markdown pages in your project as PDF files using WeasyPrint. - (only in `1.0-pdf` tag) -- [PDF generate](https://github.com/orzih/mkdocs-with-pdf) will generate a - single PDF file from MkDocs repository. (only in `1.0-pdf` tag) +- [PDF export](https://github.com/zhaoterryy/mkdocs-pdf-export-plugin) will + export all markdown pages in your project as PDF files using WeasyPrint. (only + in `1.0-pdf` tag) +- [PDF generate](https://github.com/orzih/mkdocs-with-pdf) will generate a + single PDF file from MkDocs repository. (only in `1.0-pdf` tag) ### Markdown extension -- [Include](https://github.com/cmacmackin/markdown-include/) allows the - inclusion of the contents of other Markdown documents. -- [Pygments](http://pygments.org/) is a generic syntax highlighter. -- [PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions/) is - a collection of extensions for Python Markdown. +- [Include](https://github.com/cmacmackin/markdown-include/) allows the + inclusion of the contents of other Markdown documents. +- [Pygments](http://pygments.org/) is a generic syntax highlighter. +- [PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions/) is a + collection of extensions for Python Markdown. Usage ----- @@ -119,10 +123,11 @@ Tags Related images -------------- -- [Sphinx](https://github.com/minidocks/sphinx-doc) +- [Sphinx](https://github.com/minidocks/sphinx-doc) Alternatives ------------ -- https://github.com/raspberryvalley/docker-mkdocs -- https://github.com/pozgo/docker-mkdocs +- https://github.com/raspberryvalley/docker-mkdocs +- https://github.com/pozgo/docker-mkdocs +- https://github.com/squidfunk/mkdocs-material diff --git a/build.sh b/build.sh index 1bda91d..06386c6 100755 --- a/build.sh +++ b/build.sh @@ -3,9 +3,9 @@ set -e image="${namespace:-minidocks}/mkdocs" versions=" -1;1.3.1 -1-pdf;1.3.1;weasyprint;pdf -latest;1.3.1; +1;1.4.2 +1-pdf;1.4.2;weasyprint;pdf +latest;1.4.2; " build() {