ssg is a tiny Markdown → HTML static site generator.
Install ssg with
npm i -g @tdjsnelling/ssg
or
yarn global add @tdjsnelling/ssg
ssg only requires a path to the directory you wish to build.
ssg .
Markdown files will be compiled to HTML and all other static assets will be copied over to the build directory. HTML is run through prettier to ensure built files remain human readable and editable.
Optionally, you can tell ssg to serve the build and watch for
changes with the --serve
or -s
option. By
default the server runs on port 3000, this can be changed with the
--port
or -p
option.
ssg . -s -p 5000
ssg will automatically rebuild files as and when it detects changes.
Each markdown file can have an 'options' section before the content, to
configure the build process. This section is enclosed in double-percent
symbols, %%
.
The existing options are as follows:
<title>
to include in the page headyes
, include KaTeX rendering support on the page
yes
, include syntax highlighting support on the
page
default
is used
A basic markdown file might look like this:
title = ssg demo
style = index.css
code = yes
# ssg demo
This is a demo file for ssg.
Here is some code to be highlighted: