Skip to content

Page Status: Work in Progress
 Cleaned up and clarified certain sections, some are still unfinished WUT

Random stuff on MKDocs (+ Material)

Automatic page status

Thanks to Kai Anter's Digital Garden I was able to configure an easy way to apply a "label" to every page without becoming stupid in copy-pasting long piece of codes.

BUT

There are some caviat:

theme:
  name: material
  custom_dir: overrides

      Then the folder 'overrides'

  • No matter what, the text is static, meaning that you'll always get something like this:

Info

Page status

      So, except for the obvious change, this is the changed code of the content.html page:

content.html
{% include "partials/tags.html" %}
{% include "partials/actions.html" %}
{% if "\x3ch1" not in page.content %}
  <h1>{{ page.title | d(config.site_name, true)}}</h1>
{% endif %}

<!-- This is the snippet that displays the status -->
{% if page.meta and page.meta.status %}
  {% if config.extra.status %}
    {% if page.meta.status in config.extra.status %}
      {% if page.meta.status == "draft" %}
        <div class="admonition draft">
        <p class="admonition-title">
          <span>Page Status: {{ config.extra.status[page.meta.status] }}<br></span>
          <span>Rough and early ideas, don't expect too much (especially finished sentences)</span>
          {% if config.extra.status_explanation %}
          <span>
            <a href="{{- config.extra.status_explanation.url | url -}}">{{- config.extra.status_explanation.text -}}</a>
          </span>
          {% endif %}
        </p>
      </div>
      {% elif page.meta.status == "wip" %}
        <div class="admonition wip">
        <p class="admonition-title">
          <span>Page Status: {{ config.extra.status[page.meta.status] }}<br></span>
          <span>Cleaned up and clarified certain sections, some are still unfinished</span>
          {% if config.extra.status_explanation %}
          <span>
            <a href="{{- config.extra.status_explanation.url | url -}}">{{- config.extra.status_explanation.text -}}</a>
          </span>
          {% endif %}
        </p>
      </div>
      {% else %}
        <div class="admonition done">
        <p class="admonition-title">
          <span>Page Status: {{ config.extra.status[page.meta.status] }}<br></span>
          <span>(Mostly) Done and complete, but still checked sometimes</span>
          {% if config.extra.status_explanation %}
          <span>
            <a href="{{- config.extra.status_explanation.url | url -}}">{{- config.extra.status_explanation.text -}}</a>
          </span>
          {% endif %}
        </p>
      </div>
      {% endif %}
    {% endif %}
  {% endif %}
{% endif %}

{{ page.content }}

{% include "partials/source-file.html" %}
{% include "partials/feedback.html" %}
{% include "partials/comments.html" %}

Basically I rewrote what the engine would render for each status, writing a meaningful description rather than a mere status page report.

Error 404 page not used

I completely forgot that we're talking about, at the end of the day, of a static HTML website... I had to configure the error page in Apache (yep, I don't like nor use [wherever possible] Nginx) with the directive:

/etc/apache2/sites-enabled/digitalgarden.maggiolo.net.conf
[...]
ErrorDocument 404 /404.html
[...]