go-magnet

README

MAGNET

                                             888
                                             888
                                             888
88888b.d88b.  8888b.  .d88b. 88888b.  .d88b. 888888
888 "888 "88b    "88bd88P"88b888 "88bd8P  Y8b888
888  888  888.d888888888  888888  88888888888888
888  888  888888  888Y88b 888888  888Y8b.    Y88b.
888  888  888"Y888888 "Y88888888  888 "Y8888  "Y888
                          888
                     Y8b d88P
                      "Y88P"

What

Magnet is yet another static site generator. It takes markdown you've written and turns it into HTML, ready to be pushed somewhere and served. How you serve it is up to you.

Magnet tries to be minimal, using markdown files, a yaml for settings, a few json files as indices. Unix philosophy: "Make each program do one thing well".

Install From Source

go install gitlab.com/83h3m07h/go-magnet@latest

Requires Go v1.17 or greater.

Install Build

Get builds here:

https://gitlab.com/83h3m07h/go-magnet-builds

Getting Started

You can create a new Magnet blog by doing this at the commandline:

go-magnet new

This will create a directory called "magnet". If you want to specify the name of the new directory use:

go-magnet new -path=some-new-directory-magnet-will-create

Follow the command instructions at the end of that process.

For a list of commands you can:

go-magnet help

Docs

Are included in a new magnet instance, under "/tag/docs/", or here.

Documentation

Overview

Code generated by rice embed-go; DO NOT EDIT.