From efa4f2640fd3f248d4b083bce511bf9e57d99c63 Mon Sep 17 00:00:00 2001 From: Joey Guerra Date: Sat, 14 Oct 2023 00:05:46 -0500 Subject: [PATCH] feat: initial release --- README | 46 ++++++++++++++++++++++++++++++++++++++++++++++ package.json | 7 +++++++ 2 files changed, 53 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..1b5f3b4 --- /dev/null +++ b/README @@ -0,0 +1,46 @@ +# Static Site Generator + +This is a simple static site generator that uses Express, markdown, and Handlebars to generate a static website. + +## Installation + +To install the dependencies, run: +`npm i` + +## Example building a site + +```sh +./ +./docs +./docs/index.md +./docs/layouts/ +.docs/layouts/index.html +``` + +**index.md** + +```markdown +--- +title: Getting Started With sfab +layout: layouts/index.html +published: 2023-10-14T19:25:22.000Z +permalink: /index.html +--- + +# Getting Started With sfab + +This is an example markdown file that utilizes the layouts/index.html layout file. +``` + +**layouts/index.html** + +```html + + + + + {{> @partial-block }} + + +``` + diff --git a/package.json b/package.json index a97688d..2673433 100644 --- a/package.json +++ b/package.json @@ -40,5 +40,12 @@ "scripts": { "test": "node --test", "start": "node bin/sfab" + }, + "release": { + "branches": [ + "main", + "next" + ], + "dryRun": false } }