@deoxys-1/md-to-site v1.8.1

Markdown to Site

This is a continuation of the tool originally created by danielefavi whose code can be found here

Markdown to Site is a NPM package that converts a folder containing markdown files to a static website.

It automatically creates the menu, search engine and the table of contents. If there are subfolders with markdown files it will create the submenus accordingly.

Installation

TODO: upload to npmjs

npm install -g @deoxys-1/md-to-site

How to convert markdown files to a website

Run the command below in the directory that contains your markdown files:

md-to-site build

It creates a new folder called build that will contains the HTML website.

Optionally, you can specify a source folder and/or a target folder:

md-to-site build ~/Desktop/markdown ~/Desktop/docs_site

For more information please type md-to-site -h for the help.

Notes

If you have images or other assets in your markdown folder, then you have to transfer them manually into the folder where you compiled the files.
The author of this package did not want to copy other asset files automatically because you might not want to copy personal files.

List of Parameters

Usage: md-to-site <command> [options]

Commands:
  md-to-site build <source> <target>  Builds the website from the markdown code.

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
  

md-to-site build <source> <target>

Builds the website from the markdown code.

Positionals:
  source  Directory of the source folder containing the markdown files.
                                                             [string] [required]
  target  Directory where the compiled HTML are going to be stored.
                                                             [string] [required]

Options:
      --help        Show help                                          [boolean]
      --version     Show version number                                [boolean]
  -i, --include     Include only the paths that match the given regex string.
                                                                        [string]
  -e, --exclude     Exclude the paths that match the given regex string.[string]
  -n, --index       File name that will be set as index.html. By default is READ
                    ME.md; if there is no README.md then it will be the first oc
                    currence.                                           [string]
  -t, --site-title  Title of the website: it will appear on the title tag and on
                     top of the menu.                                   [string]
      --hide        Hide the functionalities or part of the website. Insert the
                    list of items to hide comma separated. Possible values: sear
                    ch, toc.                                            [string]
                    

Docker

To build the image run the following command in the root of this source folder:

docker build --tag md-to-site ./

To run the container run the following command:

docker run -v [Path to input folder]:/in -v [Path to output folder]:/out --rm md-to-site build /in /out

For example:

docker run -v $PWD/pagebuilder:/in -v $PWD/pagebuilder/out:/out --rm md-to-site build /in /out

Or just pull the image directly from Docker Hub without building:

docker run --rm deoxys/md-to-site