Sign inSign up

vssware/mkdocs

By vssware

Updated over 6 years ago

Image
0

973

vssware/mkdocs repository overview

基于 vssware/python 镜像创建,使用源码进行编译。

参见https://www.mkdocs.org
镜像内置 Material for MkDocs, 参见 https://squidfunk.github.io/mkdocs-material/

初始化

数据卷初始化
#初始化数据卷
mkdir -p /data/docker/mkdocs && chmod -R 777 /data/docker/mkdocs

创建

系统会默认生成mkdocs项目

# 项目名称,此处范例为docs
project="docs"
docker run -it \
    --rm \
    -v /data/docker/mkdocs:/data/mkdocs:Z \
     vssware/mkdocs \
     mkdocs new $project 

常规运行

docker run -d \
    -p 8000:8000 \
    -h mkdocs \
    --name mkdocs \
    --restart always \
    -v /data/docker/mkdocs:/data/mkdocs:Z \
    vssware/mkdocs 

生成静态网站

docker run -it \
   --rm \
   -v /data/docker/mkdocs:/data/mkdocs:Z \
    vssware/mkdocs \
    mkdocs build --clear

复制_book至nginx下部署即可实现静态部署

其他

配置 mkdocs.yml,参考配置

site_name: 'VSSWARE 文档库'
site_description: 'VSSWARE 文档库'
site_author: 'Jimmy Shine'
#site_url: 'https://doc.vssware.com'

copyright: 'Copyright © 2010 - 2020 VSSWARE.COM All Rights Reserved.'

#extra_css: [markdown.css]

# Configuration
theme:
  name: 'material'
  language: 'zh'
#  palette:
#    primary: 'cyan'
#    accent: 'cyan'


# Extensions
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
      linenums: false
  - toc:
      permalink: true
  - footnotes
  - meta
  - def_list
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_png
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist
  - pymdownx.tilde

Tag summary

Content type

Image

Digest

Size

224.7 MB

Last updated

over 6 years ago

docker pull vssware/mkdocs