Extensions

extensions 導入の備忘録。

Material Extensions

materialテーマ標準のextensions。

Admonition

mkdocs.yml :

markdown_extensions:
  - admonition

Types:

Note

Qualifiers: note , seealso

Abstract

Qualifiers: abstract, summary, tldr

Info

Qualifiers: info, todo

Tip

Qualifiers: tip, hint, important

Success

Qualifiers: success, check, done

Question

Qualifiers: question, help, faq

Warning

Qualifiers: warning, caution, attention

Failure

Qualifiers: failure, fail, missing

Danger

Qualifiers: danger, error

Bug

Qualifiers: bug

Example

Qualifiers: example

Quote

Qualifiers: quote, cite

Changing the title:

Result

おすきなタイトル

に変更できます。

md

!!! note "おすきなタイトル"
    に変更できます。

Removing the title:

Result

たいとるなし

md

!!! note ""
    たいとるなし

Collapsible blocks：

Result

Click me!!

本文を収納・展開できます

md

??? note "Click me!!"
    本文を収納・展開できます

CodeHilite

• CodeHilite - Material for MkDocs

mkdocs.yml:

markdown_extensions:
  - codehilite

行番号表示：

Result

""" Bubble sort """
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

md

``` python linenums="1"
""" Bubble sort """
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
```

特定の行をハイライトする；

Result

\documentclass{jsarticle}
\begin{document}
  \begin{align}
    H \psi = E \psi
  \end{align}
\end{document}

md

```tex hl_lines="1-2 6"
\documentclass{jsarticle}
\begin{document}
  \begin{align}
    H \psi = E \psi
  \end{align}
\end{document}
```

---

PyMdown Extensions

絵文字 Emoji

• Emoji cheat sheet

installation:

pip install pymdown-extensions
pip install mkdocs-material-extensions

mkdocs.yml:

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

examples:

• :smile:
• :hankey: :poop: :shit:
• :+1:

SmartSymbols

• SmartSymbols - PyMdown Extensions Documentation

mkdocs.yml :

markdown_extensions:
  - pymdownx.smartsymbols:
      fractions: false #? does not work
      ordinal_numbers: false

Markdown	Result
(tm)	™
(c)	©
(r)	®
c/o	℅
+/-	±
-->	→
<--	←
<-->	↔
=/=	≠
1/4, etc.	¼, etc.
1st 2nd etc.	1st 2nd etc.

Keys

• Keys - PyMdown Extensions Documentation

mkdocs.yml :

markdown_extensions:
  - pymdownx.keys

Markdown	Result
++cmd+comma++	Cmd+,
++a+b+c+space++	A+B+C+Space

InlineHilite

• InlineHilite - PyMdown Extensions Documentation

markdown_extensions:
  - pymdownx.inlinehilite

Markdown	Result
`\usepackage{amsmath}`	\usepackage{amsmath}
`:::tex \usepackage{amsmath}`	\usepackage{amsmath}
`#!tex \usepackage{amsmath}`	\usepackage{amsmath}

tabbed

Result

tab 1

tab 1

tab 2

tab 2

tab 3

tab 3

tab 4

tab 4

md

=== "tab 1"
  tab 1
=== "tab 2"
  tab 2
=== "tab 3"
  tab 3
=== "tab 4"
  tab 4

続けて書くけど区切りたいときは === のあとに ! を入れる；

Result

Bash

#!/bin/bash

echo "Hello world!"

C

#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

C++

#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

C#

using System;

class Program {
  static void Main(string[] args) {
    Console.WriteLine("Hello world!");
  }
}

md

=== "Bash"
    ``` bash
    #!/bin/bash

    echo "Hello world!"
    ```

=== "C"
    ``` c
    #include <stdio.h>

    int main(void) {
      printf("Hello world!\n");
      return 0;
    }
    ```

===! "C++"
    ``` c++
    #include <iostream>

    int main(void) {
      std::cout << "Hello world!" << std::endl;
      return 0;
    }
    ```

=== "C#"
    ``` c#
    using System;

    class Program {
      static void Main(string[] args) {
        Console.WriteLine("Hello world!");
      }
    }
    ```

---

MkDocs+

Font Awesome

• Font Awesome - MkDocs+

pip install fontawesome_markdown

mkdocs.yml :

markdown_extensions:
  - fontawesome_markdown

extra_css:
  - "https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css"

examples:

• :fa-external-link:
• :fa-coffee:
• :fa-twitter:
• :fa-github:

---

Others

indent spaces

• Incorrect rendering of nested lists · Issue #545 · mkdocs/mkdocs
• MkDocs でスペース2個のインデントをリストのネストとして認識させたい場合 - stamemo

indentに必要はスペースはデフォルトでは 4 つになっている。 不便なので、2 つに変更する。

pip install mdx_truly_sane_lists

mkdocs.yml :

markdown_extensions:
  - mdx_truly_sane_lists

これで、スペース2つでもタブとして認識する。

Question

それでも、一部機能はスペース4つじゃないと効かない？

定義リスト

mkdocs.yml :

markdown_extensions:
  - def_list

Result

たーむ

にゃおああああああああああああああああああああああああああああうぎゃあああああああああああああああああああああああああああああああああああああああああなんでえええええええええええええええ

md

たーむ
:  にゃおああああああああああああああああああああああああああああうぎゃあああああああああああああああああああああああああああああああああああああああああなんでえええええええええええええええ

リンクを新規タブで開く

markdown_extensions:
  - attr_list

kmarkdown と同じようにしてリンクを書く；

[リンク名](URL){target=_blank}

---

最終更新日: July 12, 2021 08:12:48

コメント