You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.1KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. # Gutenberg
  2. ## Design
  3. Can be used for blogs or general static pages
  4. Commands:
  5. - new: start a new project -> creates the structure + default config.toml
  6. - build: reads all the .md files and build the site with template
  7. - serve: starts a server and watches/reload the site on change
  8. All pages go into the `content` folder. Subfolder represents a list of content, ie
  9. ```bash
  10. ├── content
  11. │   ├── posts
  12. │   │   └── intro.md
  13. │   └── some.md
  14. ```
  15. `some.md` will be accessible at `mywebsite.com/some` and there will be other pages:
  16. - `mywebsite.com/posts` that will list all the pages contained in the `posts` folder
  17. - `mywebsite.com/posts/intro`
  18. ### Building the site
  19. Get all .md files in content, remove the `content/` prefix to their path
  20. Split the file between front matter and content
  21. Parse the front matter
  22. markdown -> HTML for the content
  23. ### Themes
  24. Gallery at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark
  25. # TODO:
  26. - find a way to add tests
  27. - syntax highlighting
  28. - pass a --config arg to the CLI to change from `config.toml`
  29. - have verbosity levels with a `verbosity` config variable with a default