MkDocs - Instalando plugins basicos¶

Instalando o tema Material¶

pip install mkdocs-material

Carregando o Tema:

theme:
  name: material

  features:
    - instant
    - tabs

  language: pt

  palette:
    # Escuro 
    #scheme: slate
    # Claro
    scheme: default

    primary: indigo
    accent: indigo

  font:
    text: Ubuntu
    code: Ubuntu Mono

  icon:
    logo: material/library
    repo: fontawesome/brands/git-alt

  favicon: images/favicon.png

  repo_name: squidfunk/mkdocs-material
  repo_url: https://github.com/squidfunk/mkdocs-material

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/squidfunk
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/squidfunk
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/squidfunk

google_analytics:
  - UA-XXXXXXXX-X
  - auto

extra:
  disqus: your-shortname

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true

plugins:
    lang:
        - en
        - pt

Instalando o Plugin minify¶

pip install mkdocs-minify-plugin

Carregando o Plugin

Edite o arquivo config.yml e adicione

plugins:
    - search
    - minify-plugin

Instalando o Plugin Minification¶

The mkdocs-minify-plugin will minify all *.html files generated by mkdocs build in a post-processing step, stripping all unnecessary characters to reduce the payload served to the client.

pip install mkdocs-minify-plugin

plugins:
  - search # necessary for search to work
  - minify:
      minify_html: true

Instalando o Plugin Revision date¶

The mkdocs-git-revision-date-localized-plugin will add the date on which a Markdown file was last updated at the bottom of each page.

pip install mkdocs-git-revision-date-localized-plugin

plugins:
  - search # necessary for search to work
  - git-revision-date-localized:
      type: date

Referencia:¶

Última atualização: 24 de setembro de 2020