|
12345678910111213141516171819202122232425262728293031323334353637383940414243 |
- # 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
-
- ```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
-
- # TODO:
-
- - find a way to add tests
- - 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
|