https://github.com/tdjsnelling/ssg
ssg is a tiny Markdown → HTML static site generator.
https://github.com/tdjsnelling/ssg
markdown nodejs static-site-generator
Last synced: 13 days ago
JSON representation
ssg is a tiny Markdown → HTML static site generator.
- Host: GitHub
- URL: https://github.com/tdjsnelling/ssg
- Owner: tdjsnelling
- License: mit
- Created: 2020-03-25T20:14:13.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-28T17:27:27.000Z (almost 6 years ago)
- Last Synced: 2025-03-18T00:16:55.239Z (10 months ago)
- Topics: markdown, nodejs, static-site-generator
- Language: JavaScript
- Size: 83 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://prettier.io/) 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 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](https://github.com/highlightjs/highlight.js/tree/master/src/styles), otherwise `default` is used
## Example
This README is built in the [example](./example) folder. See the built page [here](https://tdjsnelling.github.io/ssg/example/build/index.html).