Skip to main content

An MkDocs plugin for www.lesliezhu.com blog.

Project description

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:
      globs:
          - test1.md
      regex:
          - 'test[3-9].md$'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_minyilife_plugin-0.0.5-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_minyilife_plugin-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_minyilife_plugin-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/6.0.0 pkginfo/1.7.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.2

File hashes

Hashes for mkdocs_minyilife_plugin-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 52b457a926d82c2ec94f47f8309ac33ece56b06ee2d272accae1d7a87f1c5fe7
MD5 e897a982a1e5dfb43a405ebb49d56f03
BLAKE2b-256 be625112b45542d3e8605cdf11b13d4b707e9b68ac8406d0d377b7569a1efc3f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page