組み込みテーマ

Miyadaiku には、デフォルトで次のテーマが組み込まれています

miyadaiku.themes.base

miyadaiku.themes.base は、デフォルトで使用されるHTMLテンプレートを提供するテーマで、プロジェクトの config.yml でテーマとして指定しなくとも、常に使用されます。

テンプレート

次のテンプレートを提供します。

page_article.html

アーティクル のデフォルトJinja2 テンプレートです。

ソースファイル: page_article.html

page_index.html

インデックス のデフォルトJinja2 テンプレートです。

ソースファイル: page_index.html

マクロ

macro という名前のモジュールを定義し、以下のマクロを提供します。

macro.google_analytics()

Google Analytics のタグを出力します。トラッキングIDは、プロジェクトプロパティの ga_tracking_id を使用します。

page_article.html:
{% block head %}
  {{ super() }}
  {{ macro.google_analytics() }}
{% endblock head %}

macro.opengraph(page)

page で指定したアーティクルの情報から、次のメタデータを出力します。

プロパティ:

  • og:url

  • og:locale

  • og:type

  • og:title

  • og:description

  • description

  • og:image

  • article:published_time

page_article.html:
{% block head %}
  {{ super() }}
  {{ macro.opengraph(page) }}
{% block head %}

miyadaiku.themes.docutils_html5

Docutilsの html5_polyglot writer 用 CSSファイルを提供します。

使い方

  1. config.yml ファイルの themes に、miyadaiku.themes.docutils_html5 を追加します。

    config.yml:
    themes:
      - miyadaiku.themes.docutils_html5
    
  2. テンプレートの head 要素で、docutils_html5 モジュールの load_css(page) を呼び出し、CSSファイルを指定する link 要素を出力します。

    page_article.html:
    {% block head %}
      {{ super() }}
      {{ docutils_html5.load_css(page) }}
    {% endblock head %}
    

miyadaiku.themes.ipynb

Jupyter Notebook 用のCSSファイルを提供します。

サンプル

https://github.com/miyadaiku/miyadaiku-docs/tree/master/samples/ipynb

使い方

  1. config.yml ファイルの themes に、miyadaiku.themes.ipynb を追加します。

    config.yml:
    themes:
      - miyadaiku.themes.ipynb
    
  2. テンプレートの head 要素で、ipynb モジュールの load_css(page) を呼び出し、CSSファイルを指定する link 要素を出力します。

    page_article.html:
    {% block head %}
      {{ super() }}
      {{ ipynb.set_header() }}
    {% endblock head %}
    

miyadaiku.themes.pygments

Pygments の組み込みスタイル用のCSSファイルを提供します。次のCSSファイルを指定できます。

  • pygments_abap.css

  • pygments_algol.css

  • pygments_algol_nu.css

  • pygments_arduino.css

  • pygments_autumn.css

  • pygments_borland.css

  • pygments_bw.css

  • pygments_colorful.css

  • pygments_default.css

  • pygments_emacs.css

  • pygments_friendly.css

  • pygments_fruity.css

  • pygments_igor.css

  • pygments_lovelace.css

  • pygments_manni.css

  • pygments_monokai.css

  • pygments_murphy.css

  • pygments_native.css

  • pygments_paraiso.css

  • pygments_pastie.css

  • pygments_perldoc.css

  • pygments_rainbow_dash.css

  • pygments_rrt.css

  • pygments_tango.css

  • pygments_trac.css

  • pygments_vim.css

  • pygments_vs.css

  • pygments_xcode.css

使い方

  1. config.yml ファイルの themes に、miyadaiku.themes.pygments を追加します。

    config.yml:
    themes:
      - miyadaiku.themes.pygments
    
  2. config.yml ファイルの pygments_css に、使用するCSSファイル名を指定します。指定しない場合は、pygments_native.css を使用します。

    config.yml:
    pygments_css: pygments_native.css
    
  1. テンプレートの head 要素で、pygments モジュールの load_css(page) を呼び出し、CSSファイルを指定する link 要素を出力します。

    page_article.html:
    {% block head %}
      {{ super() }}
      {{ pygments.load_css(page) }}
    {% endblock head %}
    

miyadaiku.themes.sample.blog

ブログサイトのサンプルテーマです。使い方は、Blogサイトの作成 を参照してください。