Skip to main content

Miyadaiku is a flexible static site generator for Jinja2 artists.

  • Contents are written in reStructuredText, Markdown, HTML, Jupyter Notebook and YAML.

  • Jinja2 templates to create HTML pages.

  • Jinja2 tags can be used in your contents too. Miyadaiku provides ReST/Markdown extensions to write Jinja2 in content files.

  • Hierarchical contents property. Each directory can have default property values for documents. These property values are also applied to contents of their sub-directories.

  • Theme system to share templates, CSS, Javascript, Image or any other contents files.

  • Themes are managed as Python package. You can install themes from PyPI with pip.

  • Generate index pages and Atom/RSS feeds for Blog sites.

Documents

https://miyadaiku.github.io

Requirements

Miydaiku requires Python 3.7 or later.

Installation

Use pip to install miyadaiku.

$ pip3 install miyadaiku

History

1.27.0

Fix for feedgenerator 2.0

1.26.0

  • Remove pgktuils

1.25.0

  • Support target markup in ipynb files

1.24.1

  • Support recent python-markdown.

1.24.0

  • strip_directory_index property specifies a file name to be striped from the page URL.

1.23.0

  • Support new version of tzlocal module.

1.22.0

  • <meta http-equiv=”refresh” …> element is emitted if refresh_to property is path to the target page.

  • search argument of context.link_to() is not regular expression but plain text.

1.21.1

  • updated property is used as updated element of feed if specified.

  • search argument of context.link_to() is not regular expression but plain text.

1.21.0

  • abstract_html property specifies static abstract text of content in HTML.

1.20.0

  • Fix bug in jinja tag extraction.

  • short_header_id to generate short header id.

1.19.0

  • Support Python 3.9.0

  • nbconvert themes can be installed in nb_templates directory.

1.18.0

  • Add bases to the jinja variable.

  • Add ipynb_export_options config for nbexport option. Default to

    {"TagRemovePreprocessor": {
        "remove_cell_tags": ["remove_cell"],
        "remove_all_outputs_tags": ["remove_output"],
        "remove_input_tags": ["remove_input"]
        },
    }
  • Support nbconvert >= 6.0.

  • Improve file cache.

  • Add content.loader property.

1.17.0

  • :jinja:`` tag can be used in Jupyter markdown cell.

  • Generates sitemap

1.16.0

  • Removed div and a elements around headers.

1.15.0

  • Add context.get_url().

  • Deprecate ContentPropxy.url property.

1.14.0

  • Add directories property to index and feed.

  • Update samile contents created by miyadaiku-start command.

  • Rebuild if YAML files in the project contents directory are updated.

  • Escape :jinja:`` notation in markdown.

1.13.0

  • Support .txt file type.

  • Wrong tzinfo was picked to apply default timezone.

  • File name with extension ‘.j2’ is treated as HTML.

  • Ignore Yaml declarations which does not return dict.

  • New property: updated.

1.12.0

  • Build title from abstract if title_fallback is title and header element not found in the content.

  • Preserve newline in content.abstract.

  • Add .anchor-link style for .ipynb file.

  • YAML can be used in HTML content.

  • Add setattr/getattr to jinja variables.

  • Modified convention of anchor name generation.

  • Add search option to link()/link_to().

Upgrading to Miyadaiku 1.0.0

Miyadaiku 1.0.0 has some incompatible changes.

To upgrade from older version of Miyadaiku, please read following notes.

  1. Package name of external themes are changed.

    • miyadaiku.themes.bootstrap4 -> miyadaiku_theme_bootstrap4

    • miyadaiku.themes.jquery -> miyadaiku_theme_jquery

    • miyadaiku.themes.tether -> miyadaiku_theme_tether

    • miyadaiku.themes.fontawesome-> miyadaiku_theme_fontawesome

    • miyadaiku.themes.popper_js -> miyadaiku_theme_popper_js

  2. Argument names of some method of Miydaiku objects are changed.

    • value argument of path(), path_to(), link(), link_to() methods are renamed to group_value.

    • group_values jinja variable is renamed to group_value.

Release files for miyadaiku 1.27.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for miyadaiku 1.27.0
File Interpreter ABI Platform
miyadaiku-1.27.0-py3-none-any.whl Python 3 none any Details

Release files / miyadaiku-1.27.0-py3-none-any.whl

Download URL miyadaiku-1.27.0-py3-none-any.whl
Size 90.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aaaa83e70cb6126653289fc4bd9e576ff93fcc28072bd7ddb868b197f2cd4f8c
BLAKE2b-256 checksum
How to use checksums
e787325a8a8b347e7d56a30b6981de1a117644f3c6001385b47054076ebd2f7b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

1.27.0 This release

1 release file

1.26.0

1 release file

1.25.0

1 release file

1.24.1

1 release file

1.24.0

1 release file

1.23.0

1 release file

1.22.0

1 release file

1.21.0

1 release file

1.20

1 release file

1.19.0

1 release file

1.18.0

1 release file

1.17.0

1 release file

1.16.0

1 release file

1.15.0

1 release file

1.14.0

1 release file

1.13.0

1 release file

1.12.0

1 release file

1.11.0

1 release file

1.10.1

1 release file

1.10.0

1 release file

1.9.0

1 release file

1.8.1

1 release file

1.8.0

1 release file

1.7.0

1 release file

1.6.0

1 release file

1.5.0

1 release file

1.4.2

1 release file

1.4.1

1 release file

1.4.0

1 release file

1.3.0

1 release file

1.2.0

1 release file

1.1.0

1 release file

1.0.3

1 release file

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.66

1 release file

0.0.65

1 release file

0.0.64

2 release files

0.0.63

2 release files

0.0.60

2 release files

0.0.59

2 release files

0.0.58

2 release files

0.0.57

1 release file

0.0.56

1 release file

0.0.55

2 release files

0.0.54

2 release files

0.0.51

2 release files

0.0.50

2 release files

0.0.49

1 release file

0.0.48

1 release file

0.0.47

1 release file

0.0.46

1 release file

0.0.45

1 release file

0.0.44

1 release file

0.0.43

1 release file

0.0.42

1 release file

0.0.41

1 release file

0.0.40

1 release file

0.0.39

1 release file

0.0.38

1 release file

0.0.37

1 release file

0.0.36

1 release file

0.0.35

1 release file

0.0.34

1 release file

0.0.33

1 release file

0.0.32

1 release file

0.0.31

1 release file

0.0.30

1 release file

0.0.29

1 release file

0.0.28

1 release file

0.0.27

1 release file

0.0.26

1 release file

0.0.25

1 release file

0.0.24

1 release file

0.0.23

1 release file

0.0.22

1 release file

0.0.21

1 release file

0.0.20

1 release file

0.0.19

1 release file

0.0.18

1 release file

0.0.17

1 release file

0.0.16

1 release file

0.0.15

1 release file

0.0.14

1 release file

0.0.13

1 release file

0.0.12

1 release file

0.0.11

1 release file

0.0.10

1 release file

0.0.9

1 release file

0.0.7

1 release file

0.0.6

1 release file

0.0.5

1 release file

0.0.4

0.0.3

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page