showdownjs/showdown

View on GitHub
mkdocs.yml

Summary

Maintainability
Test Coverage
site_name: Showdown documentation
site_description: Showdown is a JavaScript Markdown to HTML converter

theme:
  name: material
  logo: http://showdownjs.com/apple-touch-icon.png
  favicon: http://showdownjs.com/apple-touch-icon.png
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.tasklist
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

extra_css:
  - assets/extra.css 
  
repo_url: https://github.com/showdownjs/showdown
repo_name: showdownjs/showdown
site_dir: public

nav:
  - Home:
    - Introduction: index.md
    - Donations: donations.md
    - Credits: credits.md
  - Quickstart:
    - Quickstart: quickstart.md
    - Showdown's Markdown syntax: markdown-syntax.md
    - Compatibility: compatibility.md
  - Configuration:
    - Showdown options: configuration.md
    - Available options: available-options.md
    - Flavors: flavors.md
  - CLI: cli.md
  - Integrations: integrations.md
  - Extensions:
    - Overview: extensions.md
    - Create an extension: create-extension.md
    - List of known extensions: extensions-list.md 
  - Tutorials: tutorials/index.md