mkdocs.yml

site_name: SLAM 之旅
site_description: SLAM 之旅（Journey to SLAM）是用于记录分享学习 SLAM 知识的平台
site_author: Jacob.lsx
site_url: https://lsxiang.github.io/Journey2SLAM

# Repository
repo_name: LSXiang/Journey2SLAM
repo_url: https://github.com/LSXiang/Journey2SLAM

# Copyright
copyright: 'Copyright © 2019. All rights reserved.'

# Configuration
theme:
  name: 'material'    # readthedocs material 
  # 404 page
  static_templates:
    - 404.html
  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true
  language: zh
  logo:
    icon: 'school'
  palette:
    primary: 'Blue'  # default: indigo
    accent:  'indigo'  # default: indigo
  feature:
    tabs: true
  font:
    text: Roboto
    code: Roboto Mono
  # navigation_depth: 10

# Path
docs_dir: docs

# Navigation 
nav:
- 主页: index.md
- 关于 SLAM: aboutSLAM.md
- 计算机视觉基础: 
    - 计算机视觉基础概览: computer_vision/computer_vision.md
    - 图像滤波器: computer_vision/image_filtering.md
    - 特征提取与匹配: 
        - Harris 角点检测: computer_vision/Harris.md
        - Fast 角点检测: computer_vision/FAST.md
        - ORB 特征: computer_vision/ORB.md
        - SIFT 特征: computer_vision/SIFT.md
        - SUFT 特征: computer_vision/SUFT.md
        - Haar 特征: computer_vision/Haar.md
- 多视几何: 
    - 多视几何概览: multiple_view_geometry/mvg.md
    - 数学背景 - 线性代数: multiple_view_geometry/linear_algebra.md
    - 三维运动场景的表示: multiple_view_geometry/RepreOf3DMoveScene.md
- 状态估计: 
    - 状态估计概览: state_estimation_robotics/state_estimation_robotics.md
- 开源项目:
    - 开源项目概览: projects/projects.md
    - RPG-SVO:
      - SVO 算法框架: projects/rpg_svo/algorithm_framework.md
      - SVO 代码解析: projects/rpg_svo/code_analysis.md
    - ORB-SLAM:
      - 跟踪线程: projects/orb_slam/tracking.md
      - 局部建图线程: projects/orb_slam/local_mapping.md
      - 回环检测线程: projects/orb_slam/loop_closing.md
- 其他:
    - Markdown 写作模版: others/md_template.md
    # - 待归类整合文稿: 

# Customization
extra:
  version: 1.0
  search:
    language: 'jp'
  manifest: 'manifest.webmanifest'
  social:
    - type: 'github'
      link: 'https://github.com/LSXiang'

# Google Analytics
google_analytics:
  - 'UA-XXXXXXXX-X'
  - 'auto'

# Extensions
markdown_extensions:
    # The Table of Contents extension generates a Table of Contents from a Markdown document and 
    # adds it into the resulting HTML document.
  - toc:
      # marker:           # Text to find and replace with the Table of Contents. Defaults to [TOC].
      # title:            # Title to insert in the Table of Contents’ <div>. Defaults to None
      permalink: "\ue157"   # Set to True or a string to generate permanent links at the end of each header. Useful with Sphinx style sheets.
      baselevel: 1      # Base level for headers. Defaults to 1.
      slugify: !!python/name:pymdownx.slugs.uslugify  # Callable to generate anchors.
      # separator:        # Word separator. Character which replaces white space in id. Defaults to “-”.
      # toc_depth:        # Define the range of section levels to include in the Table of Contents.Defaults to 6 (bottom).

    # The Admonition extension adds rST-style admonitions to Markdown documents.
    # directive types: "attention", "caution", "danger", "error", "hint", 
    #                  "important", "note", "tip", "warning", "admonition"
    # eg:
    #     !!! type "optional explicit title within double quotes"
    #     Any number of other indented markdown elements.
    #
    #     This is the second paragraph.
  - admonition:

    # The SmartyPants extension converts ASCII dashes, quotes and ellipses to their HTML entity equivalents.
  - smarty:
      # smart_dashes: true          # whether to convert dashes
      # smart_quotes: true  	      # whether to convert straight quotes
      # smart_angled_quotes: false  # whether to convert angled quotes
      # smart_ellipses: true 	      # whether to convert ellipses
      # substitutions: {} 	        # overwrite default substitutions

    # BetterEm is a different approach to emphasis than Python Markdown's default.
    # It works similar but handles certain corner cases differently.
  - pymdownx.betterem:
      smart_enable: all

    # The Attribute Lists extension adds a syntax to define attributes on the 
    # various HTML elements in markdown’s output.
  - attr_list:

    # The Definition Lists extension adds the ability to create definition 
    # lists in Markdown documents.
    # eg:
    #     Apple
    #     :   Pomaceous fruit of plants of the genus Malus in
    #         the family Rosaceae.
  - def_list:

    # The Tables extension adds the ability to create tables in Markdown documents.
  - tables:

    # The Abbreviations extension adds the ability to define abbreviations.
    # eg:
    #     The HTML specification is maintained by the W3C
    #     *[HTML]: Hyper Text Markup Language
    #     *[W3C]:  World Wide Web Consortium
  - abbr:

    # The Footnotes extension adds syntax for defining footnotes in Markdown documents.
    # eg:
    #     Footnotes[^1] have a label[^@#$%] and the footnote's content.
    #     [^1]: This is a footnote content.
    #     [^@#$%]: A footnote on the label: "@#$%".
  - footnotes:

    # The CodeHilite extension adds code/syntax highlighting to standard 
    # Python-Markdown code blocks using Pygments.
  - codehilite:
      use_pygments: true  # Defaults to True
      # guess_lang: false   # Automatic language detection， defaults to true.
      # linenums:         # Use line numbers, 'true' of 'false', defaults to None.
      # noclasses:        # Use inline styles instead of CSS classes. Defaults to False.
      # css_class:        # Set CSS class name for the wrapper <div> tag. Defaults to codehilite

    # The Fenced Code Blocks extension adds a secondary way to define code blocks,
    # which overcomes a few limitations of the indented code blocks.
  - fenced_code

    # The Legacy EM extension restores Markdown’s original behavior for emphasis 
    # and strong syntax when using underscores.
  - legacy_em 

    # The Meta-Data extension adds a syntax for defining meta-data about a document. 
    # It is inspired by and follows the syntax of MultiMarkdown. Currently, this extension
    # does not use the meta-data in any way, but simply provides it as a Meta attribute of
    # a Markdown instance for use by other extensions or directly by your python code.
  - meta

    # The New-Line-to-Break (nl2br) Extension will cause newlines to be treated as hard breaks
    # like StackOverflow and GitHub flavored Markdown do.
  - nl2br

    # The Sane Lists extension alters the behavior of the Markdown List syntax to be less surprising.
  - sane_lists

    # The WikiLinks extension adds support for WikiLinks
  - wikilinks

    # B64 converts all local images in a document to base64 encoding and embeds them in the document.
  # - b64

    # The Legacy Attributes extension restores Python-Markdown’s original attribute 
    # setting syntax. Older versions of Python Markdown (prior to 3.0) included built-in
    # and undocumented support for defining attributes on elements. Most users have never
    # made use of the syntax and it has been deprecated in favor of Attribute Lists. 
    # This extension restores the legacy behavior for users who have existing documents 
    # which use the syntax.
  # - legacy_attr


  ### PyMdown Extensions is a collection of extensions for Python Markdown.
  ### you can get detail from https://facelessuser.github.io/pymdown-extensions/

  - pymdownx.extrarawhtml:

    # SuperFences is like Python Markdown's fences, but better. Nest fences under lists, admonitions,
    # and other syntaxes. Combine multiple fences together in tabbed groups, and even create special
    # custom fences for content like UML.
  - pymdownx.superfences:
      highlight_code: true  # Enable or disable code highlighting.
      preserve_tabs: true   # Experimental feature that preserves tabs in fenced code blocks.
      disable_indented_code_blocks: false # Disables Python Markdown's indented code block parsing. This is nice if you only ever use fenced blocks.
      custom_fences:        # Custom fences.
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
        - name: flow
          class: uml-flowchart
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: sequence
          class: uml-sequence-diagram
          format: !!python/name:pymdownx.superfences.fence_code_format
        # - css_class:        # Class name is applied to the wrapper element of the code. 
                            # If configured, this setting will override the css_class option of either CodeHilite or Highlight. 
                            # If nothing is configured here or via CodeHilite or Highlight, the class highlight will be used.

    # Highlight allows you to configure the syntax highlighting of SuperFences and InlineHilite.
    # Also passes standard Markdown indented code blocks through the syntax highlighter.
  - pymdownx.highlight:
      css_class: codehilite #'highlight'
      # guess_lang: false
      # pygments_style: 'default'
      # noclasses: false
      # use_pygments: true
      # linenums: false
      # linenums_special: 1
      # linenums_style: 'table' # default 'table'
      # extend_pygments_lang:

    # InlineHilite highlights inline code: from module import function as func.
  - pymdownx.inlinehilite:
      custom_inline:
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.inline_mathjax_format

    # MagicLink linkafies URL and email links without having to wrap them in Markdown syntax.
    # Also, allows shortens repository issue, pull request, and commit links.
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      user: Jacob.lsx
      repo: Journey2SLAM

    # Tilde is syntactically built around the ~ character. 
    # It adds support for inserting subscripts and adds an easy way to place text in a <del> tag.
  - pymdownx.tilde:
      smart_delete: true  # Use smart logic with delete characters.
      delete: true        # Enable delete feature.
      subscript: true     # Enable subscript feature.

    # Caret is an extension that is syntactically built around the ^ character. 
    # It adds support for inserting supers^cripts^ and adds an easy way to place text in an <ins> tag.
  - pymdownx.caret:

    # SmartSymbols inserts commonly used Unicode characters via simple ASCII representations: =/= → ≠.
  - pymdownx.smartsymbols:
      # trademark:       true 	# Add syntax for trademark symbol.
      # copyright:       true 	# True 	Add syntax for copyright symbol.
      # registered:      true 	# Add syntax for registered symbol.
      # care_of:         true 	# Add syntax for care / of.
      # plusminus:       true 	# Add syntax for plus / minus.
      # arrows:          true 	# Add syntax for creating arrows.
      # notequal:        true 	# Add syntax for not equal symbol.
      # fractions:       true   # Add syntax for common fractions.
      # ordinal_numbers: true   # Add syntax for ordinal numbers.

    # Emoji makes adding emoji via Markdown easy 😄.
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_png

    # EscapeAll allows the escaping of any character, some with additional effects.
  - pymdownx.escapeall:
      hardbreak: true  # Escaped newlines will be hard breaks: <br>.
      nbsp: true       # Escaped spaces will be non-breaking spaces: &nbsp;.

    # Tasklist allows inserting lists with check boxes.
  - pymdownx.tasklist:
      custom_checkbox: true     # Generate task lists in such a way as to allow for styling the check box with CSS.
      # clickable_checkbox: true  # Enable user to interact with checkboxes.

    # ProgressBar creates progress bars quick and easy.
  - pymdownx.progressbar:
      # level_class: true       # Enables or disables the level class feature. The level class feature adds level classes in increments defined by progress_increment.
      # add_classes:            # This option accepts a string of classes separated by spaces.
      # progress_increment: 20  # Defines the increment at which the level_class classes are generated at.

    # Arithmatex is an extension that preserves LaTeX math equations (x√y3) during the Markdown 
    # conversion process so that they can be used with MathJax.
  - pymdownx.arithmatex:

    # Mark allows you to mark words easily.
  - pymdownx.mark:

    # StripHTML can strip out HTML comments and specific tag attributes.
  - pymdownx.striphtml:
      # css_class:
      # style_plain_text: false 
      # custom_inline:

    # Snippets include other Markdown or HTML snippets into the current Markdown file being parsed.
  - pymdownx.snippets:
      base_path: docs/_configurations/_snippets # A string indicating a base path to be used resolve snippet locations.
      # encoding: 'utf-8'   # Encoding to use when reading in the snippets.
      # check_paths: false  # Make the build fail if a snippet can't be found.

    # Keys makes inserting key inputs into documents as easy as pressing Ctrl＋Alt＋Del.
  - pymdownx.keys:
      separator: "\uff0b"

    # Details creates collapsible elements with <details><summary> tags.
  - pymdownx.details:

    # Critic adds handling and support of Critic Markup.
  - pymdownx.critic

    # PathConverter converts paths to absolute or relative to a given base path.
  - pymdownx.pathconverter

    # Extra is just like Python Markdown's Extra package except it uses PyMdown Extensions 
    # to substitute similar extensions.
  # - pymdownx.extra


extra_javascript:
  - _configurations/_theme_extra/theme_extra.js
  # - js/extra.js

extra_css:
  - _configurations/_theme_extra/theme_extra.css
  # - scss/extra.scss