| layout |
|---|
default |
Demo site : Visit Mini-journal Demo
Mini-Journal is a minimalist Jekyll theme designed for hosting on GitHub Pages, particularly well-suited for long-form content creators such as researchers, journal writers, bloggers, and academicians. It is straightforward to set up and deploy, with a range of pre-built features. Licensed under the MIT License. Built on top of the Jekyll Minima Theme.
Markdown features supported, with checked options:
- Headers
- Bold, Italics, Strikethrough
- Bullet Lists, Numbered Lists
- Tables
- Links
- Checklists
- Footnotes
- Sub/Super Script
- Images
- Code with Syntax Highlight
- Math (Mathjax Support)
- iFrame Embeds
- Horizontal Line
- Quotes
- Alerts
- Emoji Code
- Homepage (Recent Posts)
- All Posts Page
- About Me Page
- Dark/Light Theme
- Discussion Link
- YouTube Embed
- Table of Contents
- Social Sharing Buttons
- Download as PDF
- Sitemap & Robots.txt
- RSS Feeder
- Edit on GitHub (For GitHub Pages)
- Footer Attribution under MIT License
- Journal Translations
- Giscus Comments
Front Matter is a vital component that should be included at the beginning of every postname.md file located within the _JOURNALS folder. Here is an example of a well-structured front matter:
---
title: Your Title Here
description: A Moderately Long Description of Your Journal
date: YYYY-MM-DD
youtube: content-id-here
lang: English
Contributors: Name1, Name2
Reviewers: username1, username2
toc: true
giscus: true
---Here's how each component functions:
-
Title: Use the
titlefield to specify your post's title, which will be displayed in Header 1 format. -
Description: The
descriptionfield allows you to provide a moderately long description ( 100 words max ) that appears just below the title, offering context to your content. -
Date: Input the date in the Year-Month-Date format (e.g., YYYY-MM-DD) to display it beneath the description. This date serves for sorting posts and identifying recent entries.
-
YouTube: In the
youtubefield, you can insert the content ID for a linked YouTube video, making it easily accessible to your readers. -
Table of Contents: To include a Table of Contents, set
toctotrue. This feature enhances the navigation and user experience within your journal entry. -
Contributors: If there are any contributors you can use this frontmatter to add their name.
-
Reviewers: If there are any reviewer's reviewed your paper you can use this frontmatter to add their name.
-
giscus: If you want discussion or comments for your journal post you can enable it by setting the value of
giscustotrue -
lang: In case you have any translations for your research paper, you can use this frontmatter to make users switch between translated papers. Furthermore, it is important to adhere to a specific file naming convention in order to ensure that the logic works correctely .
For your primary research paper, let's say it's named "example.md" and it is written in English. You should include the following frontmatter like,
---
lang: English
---and for any translated versions of that paper, lets take the language of the translated paper as Spanish for exaple, you should name the files like: "example-spanish.md" and specify the language in the frontmatter as,
---
lang: Spanish
---Available alerts
- Note
- Check
- Complete
- Danger
- Error
- Example
- Important
- Info
- Issue
- Solution
- Success
- Tip
- Warning
You can use this alerts by including a liquid tag in your md page like {% include alerts/note.html content="your content goes here" %}
Fork the Mini-Journal Repo to your GitHub Profile
Customize your sites base url and other site info in /_config.yml
Feel free to change your site styles in /assets/css/styles.css
Remove the exixting example.md files from /_Journals, and add your journal files with the proper front matter values
For feature updat es to the Mini-Journal Jekyll Theme contact me via,
Also feel free to contribute to this open-source repository.