Static Site Generator


3.0.43 years ago4 years agoMinified + gzip package size for @earthtone/grayson-generator in KB


Grayson Logo HTML Generator

ci status


npm install -g @earthtone/grayson-generator


grayson [options]


  --help, -h        Output help info
  --version, -v     Output version number

  --input, -i       Source directory or file (defaults to current directory)
  --output, -o      Target directory (defaults to current directory)

  --mode, -m                Generation mode (defaults to "page")

Default options and metadata are overwritten by any options or additional metadata available in a project's package.json file via the grayson node.

    "name": "example-project",
    "version": "1.2.0",
    "description": "Example package.json File",
    "main": "index.js",
    "author": "Joe Schmoe",
    "license": "ISC",
    "grayson": {
        "input": "./md",
        "metadata": {
            "stylesheets": [
            "scripts": [ "bundle.js" ]

Additionally, any options passed in via the command-line, overwrite options passed in via package.json.



Grayson's default mode presumes input will be a directory path to multiple MD files, and will generate one HTML file per MD file in the target directory. If a single MD file is given as input, Grayson will still generate one HTML file per MD file in the given directory. Each HTML file is prepended with a <nav> element, hyperlinked to all other generated HTML output.


If the --mode option is set to "blog", an additional index.html file will be generated (if none already exists), with a <nav> element.


If the --mode option is set to "slides", all MD files are concatenated into a single HTML file, housed in individual .slide containers. No <nav> element is prepended to the generated document.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.