statico

command module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2021 License: MIT Imports: 19 Imported by: 0

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

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

Install

  • You can download the binaries from the releases page for your specific system and add it to a directory that is in your PATH variables.

Usage

$ statico [flags]

Usage of statico:
  -s -serve
        alias -serve
  -serve
        Enable file server
  -w -watch
        alias -watch
  -watch
        Start statico in watch mode

To convert the given folder of markdown into html based on the given templates and has no default templates, you can use barelyhuman.dev as a base if you don't want to write your own templates.

The tool needs a config.yml and you can find a template in this repository config.template.yml

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 © Reaper

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL