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.
- 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
- Example project structure: example/
- Real-world example website: dominikbraun.io
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.
Download the latest release, create a directory like
C:\Program Files\verless and extract the executable into that directory.
Add the directory to Path.
Assuming your project directory is my-blog, the following command builds your website:
$ docker container run -v $(pwd)/my-blog:/project verless/verlessThe 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 versionThe easiest way to create a new project is to use the verless CLI:
$ verless create project my-blogThis 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-blogAfter running the command, you can view your new project under localhost:8080. Building the website works similarly:
$ verless build my-blogBy default, verless generates the website into my-blog/target. You're now good to create your first content!
For a detailed reference, check out the documentation.
Anyone is welcome to contribute to verless. Please refer to our contribution guidelines.
