Skip to content

pic
Github
Configuration

docker-compose.yml

version: '3'

services:
  mkdocs:
    container_name: mkdocs
    image: squidfunk/mkdocs-material
    restart: always
    ports:
      - 8000:8000
    volumes:
      - ./data:/docs
      - ./data/plugins:/srv/gitbook/plugins/

./data/mkdocs.yml

site_name: Jacobstown Wiki
site_url: https://wiki.jacobstown.org/
docs_dir: docs
site_dir: site

theme:
  name: material
  palette:
    scheme: slate
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.indexes
    - toc.integrate
    - toc.follow
    - content.code.copy

draft_docs: |
  Templates/
  templates/
  test/
markdown_extensions:
  - nl2br
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

plugins:
  - search
  - callouts

After Install

  • Create directories ./data/docs
  • Run command sudo chmod -R 755 data

Plugins are installed at /srv/gitbook/plugins/book.json

Callouts Plugin Github

{
    "plugins" : [ "bootstrap-callout" ]
}

docker #docker-compose #self-hosted