hype

Introduction

hype is a CLI utility to help convert Markdown into HTML.

Installation

As a Go module, hype can be installed like any traditional Go package.

go install github.com/austintraver/hype@latest

If you'd like to install shell completions for zsh, also use the completions subcommand:

# Or any other directory contained within the ${fpath} array.
hype completion zsh > ${XDG_CONFIG_HOME}/zsh/functions/_hype

Usage

hype accepts subcommands, some of which are documented below.

• Getting help for hype:

  hype --help

  Output

  A pretty *hype* CLI to help convert Markdown to hypertext markup language (HTML)
  
  Usage:
    hype [flags]
    hype [command]
  
  Available Commands:
    convert     Transform Markdown into HTML
    help        Help about any command
    preview     Preview the Markdown files within directory DIR in a web browser
  
  Flags:
    -b, --basic           ignore extensions to Markdown syntax 
                           (default false)
    -c, --config string   user configuration file 
                           (default "${XDG_CONFIG_HOME}/hyperc.yaml")
    -v, --verbose         outputs logging information to the console
    -h, --help            help for hype
  
  Use "hype [command] --help" for more information about a command.
  

convert

Using hype to convert a Markdown file into HTML can be performed using the convert subcommand, whose usage is as follows:

hype convert < input.md

Alternatively, input and output file locations can be specified using the -i (--input) and -o (--output) flags respectively. For example:

hype convert -i input.md -o output.html

preview

If you are actively editing a Markdown file, you may want to view its rendered contents in a web browser. You can do this using the preview subcommand, which launches an HTTP server running on port 1411 hosting rendered previews of any Markdown files contained in the current directory, or a custom root specified using the --root flag.

The usage of the preview subcommand is as follows:

hype preview --root ./public

If file draft.md was located at ./public/draft, you can see an HTML rendering of the file by visiting http://localhost:1411/draft.md

If a file was located

Configuration

hype searches for a configuration file located at ${XDG_CONFIG_HOME}/hyperc.yaml. If the file is found, hype will treat each configuration specified as if the user had provided the equivalent --flag on the command line.

For this reason, any --flag that is actually provided on the command line will take priority, overriding the value set within the configuration file.

Support for configuration files in the home directory is not supported at this time.

An example configuration file is provided below:

# Use basic Markdown syntax, removing support for common extensions
basic: false

# When running the HTTP server to preview Markdown files 
# via the `server`, subcommand, listen for connections on port 1411
port: 1411