gen

command module
v0.2.3 Latest Latest
Warning

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

Go to latest
Published: Mar 18, 2020 License: MIT Imports: 1 Imported by: 0

README

gen

License Go Release Tests GoReleaser

Work in Progress: gen is not finished and has many rough edges.

An another static site generator.

Getting Started

  1. Install gen if you haven't yet.

  2. Create a new site:

     $ gen create mysite
    
  3. Change directory to mysite and serve the site locally:

     $ cd mysite
     $ gen serve
    

    Run with --help or -h for options.

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

Installation

Download the precompiled binary from releases page.

From source
  1. Install Go 1.14 if you haven't yet.

  2. Two installation options are supported:

    • Install with go get:

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

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

      Use GOBIN environment variable to change that 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 that behavior:

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

License

gen is forked from plop.


© 2020 Ilya Mateyko. All rights reserved.

© 2019 Frédéric Guillot. All rights reserved.

Use of this source code is governed by the MIT license that can be found in the LICENSE.md file.

Documentation

Overview

An another static site generator.

See https://astrophena.me/gen to learn more.

Directories

Path Synopsis
internal
buildinfo
Package buildinfo contains build information.
Package buildinfo contains build information.
cli
Package cli implements command line interface.
Package cli implements command line interface.
page
Package page implements page parsing and generation.
Package page implements page parsing and generation.
scaffold
Package scaffold implements creation of new sites.
Package scaffold implements creation of new sites.
pkg
fileutil
Package fileutil provides helper functions for working with files and directories.
Package fileutil provides helper functions for working with files and directories.

Jump to

Keyboard shortcuts

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