Skip to content

Project Structure

Jump to bottom
dino li edited this page Jan 3, 2021 · 3 revisions 
├── Rakefile
├── _config.yml
├── _includes
├── _layouts
├── _posts
├── css
├── fetch_note.py
├── fonts
├── img
├── js
├── less
├── pwa
│   └── icons
└── template

The structure is provided as above.

A short summary is

  • Rakefile is a script for creating a template post. Typing command rake post title = 'title' subtitle = 'subtitle' on the terminal will automatically create a post under the _post directory.

  • _config.yml is the config file for the project to build. This includes some settings including blog name, syntax highlight, gem file exec.

  • _include stores components for a page for instance the nav bar, multi-language settings, footer ext.

  • _layouts stores the general layout for pages like default, post, and keynote

  • _posts stores all the posts are written in the markdown

  • _site stores posts from _posts rendered in the HTML. Never push anything to the _site this has been forbidden by the .gitignore. Also, the server takes the responsibility for rendering, so the _site should always be empty.

This project uses Jekyll for building the website. Jekyll uses the Liquid template for dynamically rendering websites. More info can be revealed on official documentation

Clone this wiki locally