feat: initial release (#1)

Co-authored-by: Joey Guerra <[email protected]>
hubot-friends · Oct 14, 2023 · dfa2f66 · dfa2f66
1 parent a87e340
commit dfa2f66
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 0 deletions.
diff --git a/README 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
+<!DOCTYPE html>
+<html lang="en">
+    <head></head>
+    <body>
+    {{> @partial-block }}
+    </body>
+</html>
+```
+
diff --git a/package.json b/package.json
@@ -40,5 +40,12 @@
   "scripts": {
     "test": "node --test",
     "start": "node bin/sfab"
+  },
+  "release": {
+    "branches": [
+      "main",
+      "next"
+    ],
+    "dryRun": false
   }
 }