documentor

A minimal theme for technical blogging. Use it as a starting point to build your own or be content with its limited capability.

Installation

Add this line to your Jekyll site's Gemfile:

gem "documentor"

And add this line to your Jekyll site's _config.yml:

theme: documentor

And then execute:

$ bundle

Or install it yourself as:

$ gem install documentor

Usage

General Options

author_obfuscate_email: false
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

Adding One or More Authors

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"

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
 ...
---

Adapting the Theme to Your Language

To translate fixed strings in the theme you need to edit the corresponding file in ./data/i18n/, e.g. for the string in page404.html edit ./data/i18n/page404.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 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 --livereload 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.