A static website designed to be simple as possible.
Current commands
new : creates a post with given name
and the markdown file can be found in posts folder with name as slugged, eg. its cold outside -> its-cold-outside:
build: generates a static website based on what is inside the posts folder and opens a webserver at given port in configuration file
livereload: regenerates the website based on the changes, behaves same as build command
clean: removes the content of build folder
delete : deletes the post with given name
deleteall: removes all the content inside build and posts folder
Current configuration
port: port of the webserver
website-name: website of the name visible on tabs & website
template-name: name of the template folder
posts-per-page: how many pages should be shown per page, pagination has to be enabled for this one
pagination: true or false
icon-path: path to the website icon, if it is placed in content/static folder file name would be enough
extra to add custom content, as example given below
extra:
- { $content_path: $template_path, visible-name: $name }
- { projects.md: "projects.html", visible-name: "projects" }
TODO:
- Generating table of contents based on headers
- Pagination
- Custom page support
- [] Documentation theme
- Live reload
- Custom model data