@tdjsnelling/ssg

    1.0.0 • Public • Published

    ssg

    ssg is a tiny Markdown → HTML static site generator.

    Install

    Install ssg with

    npm i -g @tdjsnelling/ssg
    

    or

    yarn global add @tdjsnelling/ssg
    

    Usage

    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.

    Options

    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: the <title> to include in the page head
    • style: relative path to a CSS or SASS/SCSS file to include on the page. SASS/SCSS is automatically transpiled
    • math: if yes, include KaTeX rendering support on the page
    • code: if yes, include syntax highlighting support on the page
    • highlight: the syntax highlighting theme to use. should be the name of a highlight.js theme, otherwise default is used

    Example

    This README is built in the example folder. See the built page here.

    Install

    npm i @tdjsnelling/ssg

    DownloadsWeekly Downloads

    3

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    11.4 kB

    Total Files

    7

    Last publish

    Collaborators

    • tdjsnelling