Sign inSign up

tanguypoinson/mkdocs

By tanguypoinson

•Updated about 2 years ago

using mkdocs-material with flask to see the docs mounted by the user on /app/docs

Image
Integration & delivery
Developer tools
0

256

tanguypoinson/mkdocs repository overview

With squidfunk's mkdocs-material⁠ and Flask⁠, this image allows you to have a server showing all your Markdown documentation.

To use this image, you can use the following command:

docker run --network host --rm -v ${PWD}/{your-documentation-folder-name}:/app/docs tanguypoinson/mkdocs

the site will then be visible on localhost:5000

the mkdocs.yml configuration used for this site :

theme:
  name: 'material'
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - search.suggest
    - search.highlight
    - content.code.copy
  language: fr
site_name: Documentation Cutcam
site_url: https://gitlab.alma.fr/li/cutcam/cutcam/pages
plugins:
  search:
    lang: fr
    pipeline:
        - stemmer
        - stopWordFilter
        - trimmer
markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.superfences

Tag summary

Content type

Image

Digest

sha256:238fbcb90…

Size

71.9 MB

Last updated

about 2 years ago

docker pull tanguypoinson/mkdocs