Skip to content

stenodevs/steno

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A simple static site generator build with Deno

Features

  • Markdown support to generate HTML files
  • Customizable config and metas
  • Basic Frontmatter Support
  • Importing CSS and JS files
  • Short URLs
  • Theme Support
  • Live reload server
  • CLI

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.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published