andyoakley/mkdocs-blog

Blogging in mkdocs

mkdocs-blog

Allows mkdocs to be used as a simple blog.

Features:

• Provides timestamps based on folder structure
• Enables jinja2 templating
• Generates a simple RSS feed for recent content

Content layout

Assumes blog content is laid out in a standardized format with numeric years and months as follows:

docs/<year>/<month>/page.md

Within a month, file modification time is used to provide chronological ordering.

Examples

• Archive page, listing posts in chronological order
• Recently posted, listed just the most recent posts

mkdocs-blog's Issues

[Security] jinja2 template feature leads to code injection vulnerability

Can this be used to create a specific overview page?

Looking at this plugin, I was wondering if it can be used to create a overview page of current blog posts in a similar fashion to what Squidfunk has for his "blog" shown here: https://squidfunk.github.io/mkdocs-material/blog/

Unfortunately is that page there a manual thing, so if there is a way to use this plugin to make an automated generation of such a page, or a similar one, would I appreciate any help with doing this.

The source of the above page, if needed, is here: https://github.com/squidfunk/mkdocs-material/blob/master/docs/blog/index.md

Add a license

Hi, could you add a LICENSE file to your repository? It would help to improve https://github.com/pawamoy/best-of-mkdocs contents 🙂
If this project is unmaintained, just let me know 👍

more documentation

This concept seems really useful and I want to give it a try, but documentation is sparse. Can you add more details on how to install and run mkdocs-blog? Maybe provide an example project?

Titles are "None"

When following the example "archive.md"

This is a list of posts, first grouped by year, then month, then sorted by age.

{% set chronological = config['chronological'] %}

{% for year in chronological|sort(reverse=True) %}
  <h3>{{ year | strftime("%Y") }}</h3>
  {% for month in chronological[year] %}
    <h4>{{ month | strftime("%B")  }}</h4>
    {% for mtime in chronological[year][month]|sort(reverse=True) %}
      {% set page = chronological[year][month][mtime] %}
      <a href="/{{ page.url }}">{{ page.title }}</a>
      <br />
    {% endfor %}
  {% endfor %}

{% endfor %}

the page titles are shown as None.

I debugged it a little and printed page.meta which was an empty dictionary when printed to the jinja template, although I have set it using YAML syntax (also tried without setting the metadata title since I guess it should be set from the filename). I checked using a breakpoint() inside the mkdocs source code that the page.meta (and also page.title) is read correctly (inside the Page class code), so something happens between that point of code and passing the page to the jinja template.

Workaround

At time being, seems that replacing {{ page.title }} with {{ page.file.url[:-5].split('/')[-1] }} or {{ page.file.url[:-5] }} gives a desired output.

Versions

• Python 3.8.5 64-bit on Windows with

mkdocs                       1.1.2
mkdocs-blog                  0.1.0
mkdocs-bootstrap4            0.1.4
mkdocs-git-committers-plugin 0.1.10

(tried also while disabling the mkdocs-bootstrap4 theme).