nothugo

command module
v0.0.7 Latest Latest
Warning

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

Go to latest
Published: Feb 18, 2023 License: MIT Imports: 25 Imported by: 0

README

Command nothugo is a basic static site generator, taking *.md files as its
input. Its main focus is simplicity and not getting in a way of existing file
hierarchies.

Install it:

    go get github.com/artyom/nothugo

For more details see https://pkg.go.dev/github.com/artyom/nothugo

Documentation

Overview

Command nothugo is a basic static site generator, taking *.md files as its input. Its main focus is simplicity and not getting in a way of existing file hierarchies.

Usage: nothugo [flags] [mode]

Modes are:

render:

In this mode program recursively walks input directory (-src), renders *.md files to HTML, writing result to the output directory (-dst), keeping the same file tree structure. Files with names that don't match *.md pattern are either hard-linked (if possible), or copied to the destination directory. Non-regular files, or files/directories with names starting with "." (unix hidden) are skipped.

serve:

In this mode program starts basic HTTP server (-addr) serving static files from the output directory (-dst). It is not the only way to serve generated content, this can be done with any web server. Most useful for local previews.

example:

In this mode program generates example content in the input (-src) and templates (-templates) directories. It is best used to create scaffolding for a new project or get a sense on how this tool works. As a precaution it refuses to overwrite existing files.

Jump to

Keyboard shortcuts

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