https://github.com/kibatic/docker-mkdocs

https://github.com/kibatic/docker-mkdocs

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kibatic/docker-mkdocs
• Owner: kibatic
• Created: 2021-02-23T13:30:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-04T07:58:46.000Z (over 1 year ago)
• Last Synced: 2024-11-30T00:44:37.670Z (24 days ago)
• Language: Dockerfile
• Size: 5.86 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Kibatic Mkdocs

==============

Basé sur polinux/mkdocs (merci aux devs).

Cette image ajoute juste le plugin mermaid2.

Quickstart

----------

Les fichiers sont à mettre dans le répertoire docs/.

exemple de config : mkdocs.yml

```yaml

site_name: Site title

## ajouter éventuellement une nav

#nav:

#    - Accueil: README.md

# ...

theme:

  name: material

markdown_extensions:

  - admonition

  - pymdownx.highlight:

      linenums: true

  - pymdownx.superfences:

      custom_fences:

        - name: mermaid

          class: mermaid

          format: !!python/name:mermaid2.fence_mermaid

# si vous voulez un style custom

# extra_css: [extra.css]

plugins:

  - mermaid2:

      version: 8.9.0

  - search

  - mkdocs-video

```

Exemple de docker-compose.yml (avec traefik2)

```yml

version: '3.8'

services:

  app:

    image: kibatic/mkdocs

    labels:

      - "traefik.http.services.mkdocs.loadbalancer.server.port=8000"

    environment:

      LIVE_RELOAD_SUPPORT: 'true'

      ADD_MODULES: 'fontawesome-markdown mkdocs-git-revision-date-localized-plugin mkdocs-material mermaid2'

      DOCS_DIRECTORY: '/mkdocs'

    volumes:

      - .:/mkdocs

```