Skip to content

Don't let malformed issue forms pushed to GitHub

License

Notifications You must be signed in to change notification settings

yudai-nkt/gh-form

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gh-form

Badge for GitHub Releases Badge for Cargo Registry Unit test

Don't let malformed issue forms pushed to GitHub

Overview

gh-form allows you to locally preview YAML-formatted issue forms as HTML.

Screenshot of gh-form's preview

Installation

There are several ways to install gh-form depending on which toolchain you are using.

GitHub CLI users

gh-form is available as a GitHub CLI extension:

gh extension install yudai-nkt/gh-form

Rustaceans

gh-form is also available on crates.io:

cargo install gh-form

Others

Download a binary from GitHub Releases and put it in your PATH.

Synopsis

USAGE:
    gh-form <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    help       Print this message or the help of the given subcommand(s)
    preview    Start a local server to preview issue form

License

This repository is licensed under the MIT License. See LICENSE.md for details.