本文简要记录了为 Mkdocs Material Blog 添加 Google Analytics 统计分析服务。
Setting up site analytics: As with any other service offered on the web, understanding how your project documentation is actually used can be an essential success factor. Material for MkDocs natively integrates with Google Analytics and offers a customizable cookie consent and a feedback widget.
本文简要记录了为 Mkdocs Material Blog 添加 GitHub giscus 评论插件。
Adding a comment system: Material for MkDocs allows to easily add the third-party comment system of your choice to the footer of any page by using theme extension. As an example, we'll be integrating Giscus, which is Open Source, free, and uses GitHub discussions as a backend.
Material for MkDocs makes it very easy to build a blog, either as a sidecar to your documentation or standalone. Focus on your content while the engine does all the heavy lifting, automatically generating archive and category indexes, post slugs, configurable pagination and more.
A clear and concise navigation structure is an important aspect of good project documentation. Material for MkDocs provides a multitude of options to configure the behavior of navigational elements, including tabs and sections, and one of its flagship features: instant loading.
Match your brand's colors, fonts, icons, logo, and more with a few lines of configuration – Material for MkDocs makes it easy to extend the basic configuration or alter the appearance.
Documentation that simply works
Material for MkDocs is a powerful documentation framework on top of MkDocs, a static site generator for project documentation.
User Guide - Writing your docs。
MkDocs pages must be authored in Markdown.
MkDocs uses the Python-Markdown library to render Markdown documents to HTML.
Material for MkDocs - Python Markdown
User Guide - Customizing Your Theme。
Altering a theme to suit your needs.
If you would like to make a few tweaks to an existing theme, there is no need to create your own theme from scratch. For minor tweaks which only require some CSS and/or JavaScript, you can use the docs_dir. However, for more complex customizations, including overriding templates, you will need to use the theme custom_dir setting.
User Guide - Configuration
Project settings are configured by default using a YAML configuration file in the project directory named mkdocs.yml. You can specify another path for it by using the -f/--config-file option (see mkdocs build --help).
As a minimum, this configuration file must contain the site_name. All other settings are optional.