Skip to content

Latest commit

 

History

History
executable file
·
164 lines (116 loc) · 5.37 KB

README.md

File metadata and controls

executable file
·
164 lines (116 loc) · 5.37 KB
Raw

Unet Blog

Table of Contents

  1. Usage
  2. Writing Blog Posts
  3. Structure
  4. License

Structure

Here are the main files of the template

jekyll-theme-basically-basic
├── _draft	               # To store your drafts, they won't be published on your site
├── _includes	               # theme includes
├── _layouts                   # theme layouts (see below for details)
├── _posts                     # Blog posts
├── _sass                      # Sass partials 
├── assets
|  ├── js	                     # theme javascript, Katex, jquery, bootstrap, jekyll search, 
|  ├── css                     # isolated Bootstrap, font-awesome, katex and main css
|  ├── fonts		               # Font-Awesome, Glyphicon, and other fonts
|  └── img		       					 # Images used for the template
├── pages
|   ├── 404.md		             # To be displayed when url is wrong
|   ├── about.md               # About example page
|   ├── search.html	           # Search page
|   └── search.json            # Specify the search target (page, post, collection)
├── _config.yml                # sample configuration
└── index.html                 # sample home page (blog page paginated)

Usage

  1. Fork and clone the Unet blog repo: git clone git@github.com:org-arl/unet-blog.git
  2. Install Jekyll: gem install jekyll, check #1 if you have a problem.
  3. Install the theme's dependencies: bundle install
  4. Run the Jekyll server: jekyll serve --config _dev_config.yml or with make serve

Writing Blog Posts

Create

New posts can be created by adding a new markdown (.md) file to the _posts directory. To create a post, add a file to your \_posts directory with the following format:

YEAR-MONTH-DAY-title.md

Jekyll documentation explains how to create a new post in much more detail. The Layout section has more information on how to add various types of content to your post.

When these files are commited to this repo git commit and the pushed to Github git push, the post will automatically get published on the blog.

Drafts

Drafts are posts without a date in the filename. They're posts you're still working on and don't want to publish yet. Even if you commit these posts into this repo, they will not be publised to the blog. To create a draft, simply create a file in the \_drafts folder in your site’s root with the format title.md.

To preview your site with drafts, simply run jekyll serve --drafts --config _dev_config.yml. Each draft post will be assigned the value modification time of the draft file for its date, and thus you will see currently edited drafts as the latest posts.

Layout

Please refer to the Jekyll docs for writing posts. Non-standard features are documented below.

These are some basic features you can use with the post layout.

---
layout: post
title: Hello World                                # Title of the page
feature-img: "assets/img/sample.png"              # Add a feature-image to the post
thumbnail: "assets/img/thumbnail/sample-th.png"   # Add a thumbnail image on blog view
tags: [sample, markdown, html]
---

Post excerpt

The excerpt are the first lines of an article that is display on the blog page. The length of the excerpt has a default of around 250 characters and can be manually set in the post using:

---
layout: post
title: Sample Page
excerpt_separator: <!--more-->
---

some text in the excerpt
<!--more-->
... rest of the text not shown in the excerpt ...

The html is stripped out of the excerpt so it only display text.

Code and Syntax Highlighting

Github pages support syntax highlighting using rouge. Adding source code to your post using the standard markdown fenced code blocks, will automatically render the block as sourcecode.

For eg.

```
  int getMTU() {
    return 32         // frame size
  }
```

You can add an optional language identifier to enable syntax highlighting in your fenced code block.

For eg. following markdown will be rendered as :

```groovy
import org.arl.fjage.*
import org.arl.unet.*
``` 

import org.arl.fjage.*
import org.arl.unet.*

Math typesetting

You can wrap math expressions with $$ signs in your posts to have the corresponding latex expression to be rendered in the blog post.

For inline math typesetting, type your math expression on the same line as your content. For example:

Type math within a sentence $$2x^2 + x + c$$ to display inline

For display math typesetting, type your math expression on a new line. For example:

$$
  \bar{y} = {1 \over n} \sum_{i = 1}^{n}y_i
$$

Tags

Tags should be placed between [] in your post metadata. Separate each tag with a comma. Tags are recommended for posts and portfolio items.

For example:

---
layout: post
title: Markdown and HTML
tags: [sample, markdown, html]
---

Tags are case sensitive Tag_nAme ≠ tag_name

License

The MIT License (MIT)