documentor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e3615d8b97d84a5ab230367c4812be3ccdb84fa2efdd830b3ccc98427546ead
+  data.tar.gz: 053caa0b62720bcc44f1b282ee3464fcd7ac0a46d61ab4a8cd2812c57632b729
+SHA512:
+  metadata.gz: 4f6085ebed284a69891397528aadb0eb18ed35664bf960c8a2bce30bb3d56889605057dd2af8baffd247187f407cee6c043f97b98a66c33232d23497e7a1c65a
+  data.tar.gz: 3bde26cf98e21ba8e064460bd6502a39023eef49f57c59becaea016cd23455a439fabe2a753b07bf23347d4c76e81e3b2fe16c53aedff51bce1c75814905d4ed

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 randomchars42
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# documentor
+
+A minimal theme for technical blogging.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "documentor"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: documentor
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install documentor
+
+## Usage
+
+To translate fixed strings in the theme you need to edit the corresponding file in `./data/i18n/`, e.g. for the string in `404.html` edit `./data/i18n/404.yml`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/randomchars42/documentor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `documentor.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_config.yml

@@ -0,0 +1,59 @@
+# url:
+#description: Some description or other.
+
+# add authors like this:
+#
+# create a file like `_authors/yourname.md`:
+#
+# ---
+#   name: Your Name
+#   author-id: your_id
+#   email: you@email.address
+#   github: yourgithubname
+# ---
+# Your interesting and unique bio.
+#  ...
+#
+#
+# In the front matter of your post:
+#
+# ---
+# author-id: your_id
+#  ...
+# ---
+#
+
+author_round_mugshot: true
+index_show_header_latest: false
+short_navigation_ignore: [index, categories, page404]
+style_typewriter: true
+style_force_dark: true
+title: YOUR SITE
+
+collections:
+  authors:
+    output: true
+
+defaults:
+  - scope:
+      path: ""
+      type: "authors"
+    values:
+      layout: "author"
+  - scope:
+      path: ""
+      type: "posts"
+    values:
+      layout: "post"
+      author: "default_author"
+  - scope:
+      path: ""
+    values:
+      layout: "default"
+      language: "de"
+
+
+
+permalink: /:categories/:title:output_ext
+
+excerpt_separator: <!--more-->

data/_data/i18n.yml

@@ -0,0 +1,12 @@
+author_email: "email: "
+author_github: "github: "
+author_image_alt: "image of "
+author_orcid: "orcid: "
+categories_heading: Categories
+default_by: "by "
+default_on: ", on "
+index_aria_latest: Navigate the latest articles
+page404_subtitle: We are looking for this site as well...
+page404_text: "Meanwhile, You could have a look around:"
+short_navigation_aria_label: Navigate categories
+short_navigation_author: Author

data/_includes/short-navigation.html

@@ -0,0 +1,24 @@
+<nav {% if short_navigation_id %}id="{{ short_navigation_id }}" {% endif %}aria-label="{{ site.data.i18n.short_navigation_aria_label }}">
+    {% if short_navigation_include_home == true %}
+    <h1><a href="/">{{ site.title }}</a></h1>
+    {% endif %}
+    <ul>
+    {% for category in site.categories %}
+        {% capture category_name %}{{ category | first }}{% endcapture %}
+        <li><a href="{{ site.baseurl }}/categories/#{{ category_name | slugize }}">{{ category_name }}</a></li>
+    {% endfor %}
+    {% if site.authors.size > 1 %}
+    {% for author in site.authors %}
+        <li><a href="{{ author.url }}">{{ author.name }}</a></li>
+    {% endfor %}
+    {% else %}
+        {% assign author = site.authors | first %}
+        <li><a href="{{ author.url }}">{{ site.data.i18n.short_navigation_author }}</a></li>
+    {% endif %}
+    {% for page in site.pages %}
+        {% unless site.short_navigation_ignore contains page.layout %}
+        <li><a href="{{ page.url }}">{{ page.title }}</a></li>
+        {% endunless %}
+    {% endfor %}
+    </ul>
+</nav>

data/_layouts/author.html

@@ -0,0 +1,30 @@
+---
+layout: base
+---
+<div class="container">
+    {% assign short_navigation_id = 'short-navigation' %}
+    {% assign short_navigation_include_home = true %}
+    {% include short-navigation.html %}
+    <main id="author" class="page">
+        <article>
+            <header>
+                <h1>{{ page.name }}</h1>
+                <div class="mugshot{% if site.author_round_mugshot %} circle{% endif %}">
+                    {% if page.image %}<img src="/assets/images/{{ page.image }}" alt="{{ site.data.i18n.author_image_alt }}{{ page.name }}"/>{% endif %}
+                </div>
+            </header>
+            {{ content }}
+            <ul>
+                {% if page.email %}
+                <li>{{ site.data.i18n.author_email }}<a href="mailto:{{ page.email }}">{{ page.email }}</a></li>
+                {% endif %}
+                {% if page.github %}
+                <li>{{ site.data.i18n.author_github }}<a href="https://github.com/{{ page.github }}">{{ page.github }}</a></li>
+                {% endif %}
+                {% if page.orcid %}
+                <li>{{ site.data.i18n.author_orcid }}<a href="https://orcid.org/{{ page.orcid }}">{{ page.orcid }}</a></li>
+                {% endif %}
+            </ul>
+        </article>
+    </main>
+</div>

data/_layouts/base.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="{{ page.language }}">
+    <head>
+        <meta charset="utf-8" />
+        <meta http-equiv="x-ua-compatible" content="ie=edge" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+
+        <title>{{ page.title }} | {{ site.title }}</title>
+        <link rel="stylesheet" href="{{ '/assets/css/normalize_reset.css' | absolute_url }}" />
+        <link rel="stylesheet" href="{{ '/assets/css/main.css' | absolute_url }}" />
+    </head>
+
+    <body class="{% if site.style_typewriter %}typewriter{% endif %}{% if site.style_force_dark %} dark{% endif %}">
+        {{ content }}
+    </body>
+</html>

data/_layouts/categories.html

@@ -0,0 +1,26 @@
+---
+layout: base
+---
+<div class="container">
+    {% assign short_navigation_id = 'short-navigation' %}
+    {% assign short_navigation_include_home = true %}
+    {% include short-navigation.html %}
+    <main id="categories" class="page">
+        <header>
+            <h1>{{ site.data.i18n.categories_heading }}</h1>
+        </header>
+        <nav id="categories" aria-label="">
+            {% for category in site.categories %}
+            {% capture category_name %}{{ category | first }}{% endcapture %}
+            <section id="#{{ category_name | slugize }}">
+                <h2>{{ category_name }}</h2>
+                <ul>
+                    {% for post in site.categories[category_name] %}
+                    <li><a href="{{ post.url }}">{{post.title}}</a></li>
+                    {% endfor %}
+                </ul>
+            </section>
+            {% endfor %}
+        </nav>
+    </main>
+</div>

data/_layouts/default.html

@@ -0,0 +1,11 @@
+---
+layout: base
+---
+<div class="container">
+    {% assign short_navigation_id = 'short-navigation' %}
+    {% assign short_navigation_include_home = true %}
+    {% include short-navigation.html %}
+    <main class="page">
+        {{ content }}
+    </main>
+</div>

data/_layouts/index.html

@@ -0,0 +1,17 @@
+---
+layout: base
+---
+<main id="front" class="container">
+        <header>
+            <h1>{{ site.title }}</h1>
+            {% include short-navigation.html %}
+        </header>
+        <nav id="latest-nav" {% if site.index_show_header_latest %} aria-labelledby="#header-latest"{% else %} aria-label="{{ site.data.i18n.index_aria_latest }}"{% endif %}>
+            {% if site.index_show_header_latest %}<h2 id="header-latest">Latest</h2>{% endif %}
+            <ul>
+                {% for post in site.posts limit:5 %}
+                <li><a href="{{ post.url }}">/ {{ post.date | date: "%Y-%m-%d" }} / {{ post.categories | first }} / {{ post.title }}</a></li>
+                {% endfor %}
+            </ul>
+        </nav>
+</main>

data/_layouts/page.html

@@ -0,0 +1,11 @@
+---
+layout: base
+---
+<div class="container">
+    {% assign short_navigation_id = 'short-navigation' %}
+    {% assign short_navigation_include_home = true %}
+    {% include short-navigation.html %}
+    <main class="page">
+        {{ content }}
+    </main>
+</div>

data/_layouts/page404.html

@@ -0,0 +1,13 @@
+---
+layout: base
+---
+<main id="page404" class="container">
+    <header>
+        <hgroup>
+            <h1>404</h1>
+            <p>{{ site.data.i18n.page404_subtitle }}</p>
+        </hgroup>
+        <p>{{ site.data.i18n.page404_text }}</p>
+        {% include short-navigation.html %}
+    </header>
+</main>

data/_layouts/post.html

@@ -0,0 +1,38 @@
+---
+layout: base
+---
+<div class="container">
+    {% assign short_navigation_id = 'short-navigation' %}
+    {% assign short_navigation_include_home = true %}
+    {% include short-navigation.html %}
+    {% assign author = site.authors | where:"author-id", page.author | first %}
+    {% unless author %}
+        {% assign author = site.authors | where:"author-id", "default_author" | first %}
+    {% endunless %}
+    <main class="page">
+        <article itemscope itemtype="https://schema.org/BlogPosting" itemid="{{ site.url }}{{ page.url }}">
+            <header>
+                <h1 itemprop="name">{{ page.title }}</h1>
+                <p>
+                    {{ site.data.i18n.default_by }}<span itemprop="author" itemscope itemtype="https://schema.org/Person"><span itemprop="name"><a itemprop="url" href="{{ author.url }}">{{ author.name }}</a></span></span>{{ site.data.i18n.default_on }}<time itemprop="datePublished" datetime="{{ page.date }}">{{ page.date | date: "%Y-%m-%d" }}</time>
+                </p>
+            </header>
+            {% if page.excerpt != page.content %}
+            <section itemprop="abstract" class="abstract">
+                {{ page.excerpt }}
+            </section>
+            <section itemprop="articleBody">
+                {{ page.content | remove: page.excerpt }}
+            </section>
+            {% else %}
+            <section itemprop="articleBody">
+                {{ content }}
+            </section>
+            {% endif %}
+            <footer>
+                <p itemprop="copyrightNotice">© <time itemprop="datePublished" datetime="{{ page.date }}">{{ page.date | date: "%Y" }}</time>{{ site.data.i18n.default_by }}<span itemprop="author" itemscope itemtype="https://schema.org/Person"><span itemprop="name"><a itemprop="url" href="{{ author.url }}">{{ author.name }}</a></span></span>
+                </p>
+            </footer>
+        </article>
+    </main>
+</div>

data/assets/css/main.css

@@ -0,0 +1,267 @@
+@font-face {
+    font-family: 'MenuRegular';
+    src: url('../fonts/pixeldroidMenuRegular/pixeldroidMenuRegular.otf'), '../fonts/pixeldroidMenuRegular/pixeldroidMenuRegular.ttf') format('truetype'), url('../fonts/pixeldroidMenuRegular/pixeldroidMenuRegular-64.fnt') format('fnt');
+    font-weight: normal;
+    font-style: normal;
+}
+@font-face {
+    font-family: 'BoticRegular';
+    src: url('../fonts/pixeldroidBoticRegular/pixeldroidBoticRegular.otf'), '../fonts/pixeldroidBoticRegular/pixeldroidBoticRegular.ttf') format('truetype'), url('../fonts/pixeldroidMenuRegular/pixeldroidMenuRegular-64.fnt') format('fnt');
+    font-weight: normal;
+    font-style: normal;
+}
+
+body {
+    font-family: serif;
+    color: var(--color-onsurface);
+    background-color: var(--color-surface);
+}
+
+body, .container {
+    height: 100vh;
+}
+
+.container {
+    width: 90%;
+    max-width: 64rem;
+    margin: auto;
+    display: grid;
+    grid-template-columns: 1fr;
+    grid-template-rows: auto 1fr auto;
+    grid-template-areas:
+        "header"
+        "main"
+        "footer"
+}
+
+/**
+ * Style: Typewriter
+ */
+
+.typewriter {
+    h1, h2, h3, h4, h5, h6, p, a, li {
+        font-family: mono;
+    }
+
+    ul {
+        padding-inline-start: 1rem;
+        list-style-type: "- ";
+    }
+
+    ol {
+        padding-inline-start: 2rem;
+    }
+}
+
+/**
+ * Front Page / 404
+ */
+
+#front, #page404 {
+    ul {
+        padding-left: 0;
+        padding-right: 0;
+        list-style-type: none;
+    }
+
+    li {
+        padding-bottom: 0.5rem;
+    }
+
+    a {
+        text-decoration: none;
+    }
+
+    #latest-nav {
+        grid-area: footer;
+        font-weight: bold;
+    }
+
+    header {
+        grid-area: main;
+        align-content: center;
+
+        text-align: center;
+
+        li {
+            display: inline;
+            padding: 0 0.5rem;
+        }
+    }
+}
+
+#front {
+    h1 {
+        margin-bottom: 0;
+        font-size: clamp(2rem, 10vw, 9rem);
+        font-family: MenuRegular;
+        text-transform: none;
+    }
+
+    h2 {
+        margin: 0 0 1rem 0;
+        text-transform: none;
+        font-size: 1.5rem;
+    }
+}
+
+#page404 {
+    h1 {
+        font-size: clamp(2rem, 20vw, 9rem);
+        margin-bottom: 0;
+    }
+
+    hgroup {
+        font-size: clamp(2rem, 10vw, 9rem);
+        margin-bottom: 3rem;
+    }
+
+    h1, hgroup {
+        font-family: MenuRegular;
+    }
+}
+
+/**
+ * Short Navigation
+ */
+
+#short-navigation {
+    h1 {
+        display: inline;
+        a {
+            font-family: MenuRegular;
+        }
+    }
+
+    ul {
+        padding-left: 0;
+        padding-right: 0;
+        list-style-type: none;
+        display: inline;
+    }
+
+    li {
+        display: inline;
+        padding: 0 0.5rem;
+    }
+
+    a {
+        text-decoration: none;
+    }
+}
+
+/**
+ * Categories / Default
+ */
+
+.container {
+    &>#short-navigation {
+        grid-area: header;
+        margin: 1rem 0 3rem 0;
+    }
+
+    &>main {
+        grid-area: main;
+    }
+}
+
+.page {
+    main& {
+        padding: 0 0 0 2rem;
+    }
+
+    header {
+        text-align: center;
+        margin-left: -2rem;
+        margin-bottom: 2rem;
+
+        p {
+            text-align: inherit;
+        }
+    }
+
+    h1 {
+        text-transform: uppercase;
+    }
+
+    h2 {
+        text-transform: uppercase;
+        margin-left: -2rem;
+        font-weight: normal;
+    }
+
+    p, li {
+        line-height: 1.5;
+    }
+
+    p {
+        text-align: justify;
+    }
+
+    ul, ol {
+        padding-inline-start: 2rem;
+    }
+
+    pre {
+        margin-left: -1rem;
+        padding: 1rem;
+        border-style: solid;
+        border-width: 0 0 0 calc(1rem / 16);
+        font-family: mono;
+    }
+
+    code, pre {
+        background-color: var(--color-surfacecontainerlowest);
+        color: var(--color-onsurfacecontainerlowest);
+    }
+
+    code {
+        font-size: 0.8rem;
+        line-height: 1.5rem;
+        padding: 0 0.5rem;
+    }
+
+    .abstract {
+        font-style: italic;
+        margin-bottom: 1rem;
+    }
+
+    footer {
+        margin-top: 3rem;
+
+        p {
+            text-align: right;
+        }
+    }
+}
+
+#categories {
+    ul {
+        list-style-type: '> ';
+
+        a {
+            text-decoration: none;
+        }
+    }
+}
+
+/**
+ * Authors
+ */
+
+.mugshot {
+    max-width: 8rem;
+    max-height: 8rem;
+    display: inline-block;
+
+    &.circle {
+        border-radius: 50%;
+        overflow: hidden;
+        border-width: 0.3rem;
+        border-style: solid;
+    }
+
+    img {
+        width: 100%;
+    }
+}