README
¶
A simple and lightweight Static Site Generator.
verless (pronounced like serverless) is a Static Site Generator designed for Markdown-based content with focus on simplicity and performance. It reads your Markdown files, applies your HTML templates and renders them as a website.
Features
- Flexible templating: Create default templates for all pages or use Page Types to use custom templates
- Central configuration: Global information, enabled plugins and other settings are in
verless.yml - Rapid development: Create a fresh project within a single command
- No webserver required: verless serves your static site and re-builds it if something changes
- Build performance: Generating your static site is a matter of milliseconds
- Choose what you need: Only generate RSS feeds or overview pages for tags if you want to
- Focus on simplicity: If your project isn't simple, verless probably isn't a good fit
Examples
- Example project structure: example/
- Real-world example website: dominikbraun.io
Installation
Linux and macOS
Download the latest release for your platform. Extract the
downloaded binary into a directory like /usr/local/bin. Make sure the directory is in PATH.
Windows
Download the latest release, create a directory like
C:\Program Files\verless and extract the executable into that directory.
Add the directory to Path.
Docker
Assuming your project directory is my-blog, the following command builds your website:
$ docker container run -v $(pwd)/my-blog:/project verless/verless
The container will build the project mounted at /project and you'll find the website in my-blog/target. To run
another command, just append it to the image name:
$ docker container run verless/verless version
Getting started
The easiest way to create a new project is to use the verless CLI:
$ verless create project my-blog
This initializes a project called my-blog inside a new directory, containing a small default site. You can either
build the project or serve the static site directly:
$ verless serve -w my-blog
After running the command, you can view your new project under localhost:8080. Building the website works similarly:
$ verless build my-blog
By default, verless generates the website into my-blog/target. You're now good to create your first content!
Documentation
For a detailed reference, check out the documentation.
Contributing
Anyone is welcome to contribute to verless. Please refer to our contribution guidelines.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package builder provides a model builder implementation.
|
Package builder provides a model builder implementation. |
|
Package cli provides the verless CLI commands.
|
Package cli provides the verless CLI commands. |
|
Package main provides the verless application.
|
Package main provides the verless application. |
|
Package config provides configuration-related types and functions.
|
Package config provides configuration-related types and functions. |
|
Package core provides the verless business logic.
|
Package core provides the verless business logic. |
|
build
Package build provides verless' core build functionality.
|
Package build provides verless' core build functionality. |
|
serve
Package serve provides verless' core serve functionality.
|
Package serve provides verless' core serve functionality. |
|
watch
Package watch provides verless' ability to watch a project and react to changes in a verless project.
|
Package watch provides verless' ability to watch a project and react to changes in a verless project. |
|
Package fs provides functions for filesystem operations.
|
Package fs provides functions for filesystem operations. |
|
Package model provides the verless domain entities.
|
Package model provides the verless domain entities. |
|
Package parser provides components for parsing content.
|
Package parser provides components for parsing content. |
|
plugin
|
|
|
atom
Package atom provides and implements the atom plugin.
|
Package atom provides and implements the atom plugin. |
|
tags
Package tags provides and implements the tags plugin.
|
Package tags provides and implements the tags plugin. |
|
Package test contains some simple utils for more readable tests.
|
Package test contains some simple utils for more readable tests. |
|
Package tpl provides a simple template registry and corresponding function for registering and loading templates from that registry.
|
Package tpl provides a simple template registry and corresponding function for registering and loading templates from that registry. |
|
Package tree provides functions for performing operations related to tree data structures.
|
Package tree provides functions for performing operations related to tree data structures. |
|
Package writer provides the default build.Writer implementation capable of writing the site model to a filesystem.
|
Package writer provides the default build.Writer implementation capable of writing the site model to a filesystem. |