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.
- Flexibility: Provide and use your default template for all pages, or use a different template for a specific page
- Simplicity: Build your entire website within a single CLI command
- Performance: Generating your website only takes a few seconds, even for thousands of pages
- Rapid Development: Get started quickly with verless' small and reduced feature set
- Configurability: Provide additional information or override defaults in
verless.yml - Portability: verless is packaged as a single binary without any dependencies for multiple platforms
- 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. Building the
website corresponding 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.
