zola/README.md
2017-03-23 20:05:03 +09:00

41 lines
1.3 KiB
Markdown

# Gutenberg
[![Build Status](https://travis-ci.org/Keats/gutenberg.svg?branch=master)](https://travis-ci.org/Keats/gutenberg)
[![Build status](https://ci.appveyor.com/api/projects/status/h4t9r6h5gom839q0/branch/master?svg=true)](https://ci.appveyor.com/project/Keats/gutenberg/branch/master)
## Design
Can be used for blogs or general static pages
Commands:
- new: start a new project -> creates the structure + default config.toml
- build: reads all the .md files and build the site with template
- serve: starts a server and watches/reload the site on change
All pages go into the `content` folder. Subfolder represents a list of content, ie
```bash
├── content
│   ├── posts
│   │   └── intro.md
│   └── some.md
```
`some.md` will be accessible at `mywebsite.com/some` and there will be other pages:
- `mywebsite.com/posts` that will list all the pages contained in the `posts` folder
- `mywebsite.com/posts/intro`
### Building the site
Get all .md files in content, remove the `content/` prefix to their path
Split the file between front matter and content
Parse the front matter
markdown -> HTML for the content
### Themes
Gallery at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark
Make .themedump file:
`cargo run --example generate_themes themepack sublime_themes sublime_themes/all.themedump`