emelie/zola
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
zola/README.md
Vincent Prouillet 91fa7e358c Started working on gutenberg again
2017-02-24 11:21:58 +09:00

1 KiB
Raw Blame History

Gutenberg

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

├── 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

TODO:

  • syntax highlighting
  • pass a --config arg to the CLI to change from config.toml
  • have verbosity levels with a verbosity config variable with a default