Sign inSign up

openlab/wiki-md

By openlab

•Updated over 7 years ago

Generate a static wiki from structured markdown files

Image
0

464

openlab/wiki-md repository overview

⁠Usage

docker run -it --rm \
  -v `pwd`/your_pages_directory:/pages \
  -v `pwd`/your_output_directory:/dist \
  openlab/wiki-md --theme-color="#4b8aee"

⁠Cli help

Below is the cli --help output.

You don't need to worry about indir and outdir when using the docker image. It sets indir to /pages and outdir to /dist, which is where you should mount files

cli.js [indir] [outdir]

Generate a site from local markdown files

Positionals:
  indir   Where to recursively look for markdown files   [string] [default: "."]
  outdir  Where to put the generated html             [string] [default: "dist"]

Options:
  --version       Show version number                                  [boolean]
  -h, --help      Show help                                            [boolean]
  --site-title    The title of the site, used in the title elment
                                                               [default: "Wiki"]
  --index-file    What file to use to generate index.html files[default: "home"]
  --theme-color   The primary theme color                   [default: "#23967F"]
  --theme-invert  The inverse theme color, something contrasting themeColor
                                                            [default: "#ffffff"]
  --base-path     The base directory, if served in a folder       [default: "/"]
  --owner-name    The name of the owner of the site        [default: "Open Lab"]
  --owner-link    The link to the owner of the site
                                          [default: "https://openlab.ncl.ac.uk"]
  --verbose       Whether to describe whats happening [boolean] [default: true]

Tag summary

Content type

Image

Digest

Size

34.8 MB

Last updated

over 7 years ago

docker pull openlab/wiki-md:0.3.3