Skip to content

Releases: stenodevs/steno

v0.0.1 - Pre-alpha

26 Apr 10:41
d401227

Choose a tag to compare

v0.0.1 - Pre-alpha Pre-release
Pre-release
  1. Live reload via SSE
    Inject an EventSource snippet into served HTML, emit reload events from the file watcher on rebuild
  2. Recursive directory build
    Walk nested content/ subdirectories, preserve folder structure in dist/

For testing: The package is in pre-alpha, therefore it wanst published on npm or jsr, please clone the project to use it.

Usage

First you need to create a main file, for example mod.ts:

import { Steno } from '@steno/steno';

new Steno();

Next, you need to copy the following deno.json file:

{
  "tasks": {
    "dev": "deno run -A --watch ./mod.ts dev",
    "build": "deno run -A ./mod.ts build"
  }
}

This way, you can easily run the main commands.

Once you have the main file and the deno.json file, you can create a content folder with your markdown files.

For example, you can create a content/index.md file:

---
title: Home
---

# Hello World

Welcome to my blog. This is my first post. I hope you enjoy it. Yes.

Now, you can build the Steno project configuration:

  1. Create a folder named steno inside the content folder.
  2. Create a config.yml file inside the steno folder, for example:
title: Welcome to my blog
description: This is a blog about my life
author: John Doe

head:
  - name: icon
    content: /favicon.ico

custom:
  shortUrls: true

Finally, you can run the following command to build the project:

deno task build

This will generate the dist folder with the HTML files