gen

command module
v0.6.1 Latest Latest
Warning

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

Go to latest
Published: Dec 5, 2020 License: MIT Imports: 3 Imported by: 0

README

gen

gen is an another static site generator.

Getting Started

  1. Install gen if you haven't yet.

  2. Create a new site:

     $ gen new mysite
    
  3. Change directory to mysite, build and serve the site locally:

     $ cd mysite
     $ gen build
     $ gen serve
    

    Run with --help or -h for options.

  4. Go to http://localhost:3000.

ProTip!: you can use entr to automatically rebuild the site when changing files:

    $ while true; do find . -type f -not -path '*/\.git/*' | entr -d gen build; done

Installation

From binary

Download the precompiled binary from releases page.

From source
  1. Install the latest version of Go toolchain if you haven't yet.

  2. Two installation options are supported:

    • Install with go get:

       $ pushd $(mktemp -d); go mod init tmp; go get go.astrophena.name/gen; popd
      

      go get puts binaries by default to $GOPATH/bin (e.g. ~/go/bin).

      Use GOBIN environment variable to change this behavior.

    • Install with make:

       $ git clone https://github.com/astrophena/gen
       $ cd gen
       $ make install
      

      make install installs gen by default to $HOME/.local/bin.

      Use PREFIX environment variable to change this behavior:

       $ make install PREFIX="$HOME" # Installs to $HOME/bin.
      

License

MIT © Ilya Mateyko

Documentation

Overview

gen is an another static site generator.

Directories

Path Synopsis
internal
cli
Package cli implements the command line interface of gen.
Package cli implements the command line interface of gen.
page
Package page implements page parsing and generation.
Package page implements page parsing and generation.
scaffold
Package scaffold implements a creation of new sites.
Package scaffold implements a creation of new sites.
site
Package site implements site building.
Package site implements site building.
version
Package version contains a version of gen.
Package version contains a version of gen.
pkg
fileutil
Package fileutil provides helper functions for working with files and directories.
Package fileutil provides helper functions for working with files and directories.
frontmatter
Package frontmatter implements frontmatter-related functions.
Package frontmatter implements frontmatter-related functions.

Jump to

Keyboard shortcuts

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