1. 插件¶

pip install mkdocs-autorefs

# mkdocs.yml
plugins:
  - search
  - autorefs

markdown_extensions:
  - attr_list

Somewhere in a document.

[](){#foobar-paragraph}

Paragraph about foobar.

pip install mkdocs-autolinks-plugin

pip install mkdocs-glightbox

plugins:
   - glightbox

pip install mkdocs-minify-plugin

plugins:
  - search
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
          remove_comments: true
      cache_safe: true
      js_files:
          - my/javascript/dir/file1.js
          - my/javascript/dir/file2.js
      css_files:
          - my/css/dir/file1.css
          - my/css/dir/file2.css

pip install mkdocs-enumerate-headings-plugin

plugins:
  - search
  - enumerate-headings

plugins:
    - enumerate-headings:
        toc_depth: 0
        strict: true
        increment_across_pages: true
        include:
          - "*"
        exclude:
          - index.md
          - another_page.md
        restart_increment_after:
          - second_section.md

pip install mkdocs-add-number-plugin

plugins:
    - search
    - add-number:
        strict_mode: False
        order: 1
        excludes: 
            - sql/
            - command/rsync
        includes:
            - sql/MySQL

pip install mkdocs-link-marker

plugins:
    - search
    - link-marker

pip install mkdocs-categories-plugin

plugins:
  - categories

pip install mkdocs-with-pdf

plugins:
    - with-pdf:
        #author: WHO
        #copyright: ANY TEXT
        #
        #cover: false
        #back_cover: true
        #cover_title: TITLE TEXT
        #cover_subtitle: SUBTITLE TEXT
        #custom_template_path: TEMPLATES PATH
        #
        #toc_title: TOC TITLE TEXT
        #heading_shift: false
        #toc_level: 3
        #ordered_chapter_level: 2
        #excludes_children:
        #    - 'release-notes/:upgrading'
        #    - 'release-notes/:changelog'
        #
        #exclude_pages:
        #    - 'bugs/'
        #    - 'appendix/contribute/'
        #convert_iframe:
        #    - src: IFRAME SRC
        #      img: POSTER IMAGE URL
        #      text: ALTERNATE TEXT
        #    - src: ...
        #two_columns_level: 3
        #
        #render_js: true
        #headless_chrome_path: headless-chromium
        #
        #output_path: any-place/document.pdf
        #enabled_if_env: ENABLE_PDF_EXPORT
        #
        #debug_html: true
        #show_anchors: true
        #verbose: true

pip install mkdocs-build-plantuml-plugin

plugins:
  - search
  - build_plantuml:
      render: 'server' # or "local" for local rendering
      bin_path: '/usr/local/bin/plantuml' # ignored when render: server
      server: 'http://www.plantuml.com/plantuml' # official plantuml server
      disable_ssl_certificate_validation: true # for self-signed and invalid certs
      output_format: 'svg' # or "png"
      allow_multiple_roots: false # in case your codebase contains more locations for diagrams (all ending in diagram_root)
      diagram_root: 'docs/diagrams' # should reside under docs_dir
      output_folder: 'out'
      input_folder: 'src'
      input_extensions: '' # comma separated list of extensions to parse, by default every file is parsed

pip install mkdocs_puml

plugins:
  - plantuml:
      puml_url: https://www.plantuml.com/plantuml/

pip install mkdocs-gen-files

plugins:
  - search
  - gen-files:
      scripts:
        - gen_pages.py  # or any other name or path

pip install mkdocs-table-reader-plugin

plugins:
  - search
  - table-reader

pip install markdown_inline_graphviz_extension

markdown_extensions:
    - markdown_inline_graphviz

    ```graphviz dot attack_plan.svg
    digraph G {
        rankdir=LR
        Earth [peripheries=2]
        Mars
        Earth -> Mars
    }
    ```

pip install mkdocs-glightbox

plugins:
   - glightbox:
       touchNavigation: true
       loop: false
       effect: zoom
       slide_effect: slide
       width: 100%
       height: auto
       zoomable: true
       draggable: true
       skip_classes:
         - custom-skip-class-name
       auto_caption: false
       caption_position: bottom
       background: white
       shadow: true

pip install markdown-checklist

* [ ] foo
* [x] bar
* [ ] baz