Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barelyhuman/statico
A static site generator for creative devs
https://github.com/barelyhuman/statico
golang markdown ssg static-site-generator
Last synced: about 2 months ago
JSON representation
A static site generator for creative devs
- Host: GitHub
- URL: https://github.com/barelyhuman/statico
- Owner: barelyhuman
- License: mit
- Archived: true
- Created: 2021-04-10T11:43:47.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-01-19T07:12:35.000Z (almost 3 years ago)
- Last Synced: 2024-06-21T02:41:20.340Z (5 months ago)
- Topics: golang, markdown, ssg, static-site-generator
- Language: Go
- Homepage: https://statico.reaper.im/
- Size: 124 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Statico
A static site generator for creative devs
If you like any of my work, you can support me on: https://barelyhuman.dev/donate
[](LICENSE)
## Motivation
I use markdown for most of my writing and really like the simplicity. This started as an experiment to power my websites but is now at a decent level of generalisation to be used by others.
## Features
- Supports Templates (Go Templates)
- Watch Mode
- Local server
- ⚡ Fast
- Markdown => HTML
## Documentation
[Documentation](https://statico.reaper.im/) - You can find your documentation here
## Install
- You can download the binaries from the [releases](/releases) page for your specific system and add it to a directory that is in your `PATH` variables.
or you can use goblin
```sh
curl -sf https://goblin.reaper.im/github.com/barelyhuman/statico | sh
```
## Usage
```sh
$ statico [flags]
Usage of statico:
-c -config
alias -config
-config string
Config file to use
-init
Initialize the app
-s -serve
alias -serve
-serve
Enable file server
-w -watch
alias -watch
-watch
Start statico in watch mode
```
**statico** doesn't come with any necessary boilerplate and just injects a few variables into the provided templates using a `.config.yml` file.
You can either use the [default template](https://github.com/barelyhuman/statico-default-template/) or make your own with inspirations and hacking the following available templates
- [Default](https://github.com/barelyhuman/statico-default-template/)
- [reaper.im](https://github.com/barelyhuman/reaper.im)
- [barelyhuman.dev](https://github.com/barelyhuman/barelyhuman.dev)
The tool needs a `config.yml` and you can find a template in this repository [`config.template.yml`](/config.template.yml)
## Template Development
- If you wish to develop templates for the same, please try naming them in the following format `statico--template`, to make it easier for people looking for other templates and make sure you have a demo/preview link for the same on the repo.
- The templates are purely built on go-templates and you can include and do all kinds of stuff that you'd do with a normal go template, the only limitation being that the config can take only so many 4 types of template name so those 4 are to act as your umbrella templates, you can always use the above example templates for checking out use-cases
## Contribute
Issues and PR's are your way to go, fork the repository, create a PR and you're done. Just make sure you let the maintainer know about the issue you pick up to avoid overlaps
## License
[MIT](LICENSE) © Reaper