mkdocs-minyilife-plugin 0.0.6

An MkDocs plugin for www.lesliezhu.com blog.

mkdocs-minyilife-plugin

An MkDocs plugin for www.minyilife.com blog.

Installation

pip3 install mkdocs-minyilife-plugin

Or

pip3 install https://github.com/lesliezhu/mkdocs-minyilife-plugin/archive/refs/heads/master.zip

mkdocs-ruby-plugin

An MkDocs plugin to add pinyin/furigana to Chinese/Japanese Kanji text.

It's based on https://github.com/ijaureguialzo/mkdocs-furigana-plugin, but replace CSS style with HTML <ruby> tag.

Write kanji like this:

我(wo)是一只{猫(mao)}。猫(ねこ).

It will look like:

我wo是一只猫mao。猫ねこ.

Or like this when there is more than one character:

我(wo)是{一只猫(yizhimao)}。{綺麗猫(きれいねこ)}.

It will look like:

我wo是一只猫yizhimao。綺麗猫きれいねこ.

To enable the plugin in the mkdocs.yml file:

plugins:
  - minyilife-ruby:
      global_enable: true
      title_enable: true
      outer_begin: '{'
      outer_end: '}'
      inter_begin: '('
      inter_end: ')

If ruby.global_enable = false, you can enable this plugin in single page:

---
ruby: true
---

If ruby.global_enable = true, you can disable this plugin in single page:

---
ruby: false
---

mkdocs-exclude-plugin

An MkDocs plugin to exclude some markdown files.

It's based on https://github.com/apenwarr/mkdocs-exclude

To enable the plugin in the mkdocs.yml file:

plugins:
  - minyilife-exclude:
      log: false
      globs:
          - test1.md
      regex:
          - 'test[3-9].md$'
          - '.md#$'
          - '.md~$'
          - '\.#.*.md'

Need to use this plugin as the top priority plugin, because it needs to exclude the files at first.

If the 'log' enabled, it'll print the excluded files one by one.