Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: initial release #1

Merged
merged 1 commit into from
Oct 14, 2023
Merged

feat: initial release #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
```

7 changes: 7 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,12 @@
"scripts": {
"test": "node --test",
"start": "node bin/sfab"
},
"release": {
"branches": [
"main",
"next"
],
"dryRun": false
}
}