https://github.com/mdubourg001/ssgo

The minimalistic but flexible static site generator for Deno 🦕.
https://github.com/mdubourg001/ssgo

deno ssgo static-site-generator

Last synced: about 2 months ago
JSON representation

The minimalistic but flexible static site generator for Deno 🦕.

• Host: GitHub
• URL: https://github.com/mdubourg001/ssgo
• Owner: mdubourg001
• License: mit
• Created: 2020-04-28T16:06:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T20:59:24.000Z (4 months ago)
• Last Synced: 2024-05-22T21:59:26.550Z (4 months ago)
• Topics: deno, ssgo, static-site-generator
• Language: TypeScript
• Homepage: https://ssgo.netlify.app
• Size: 1.51 MB
• Stars: 176
• Watchers: 9
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - mdubourg001/ssgo - The minimalistic but flexible static site generator for Deno 🦕. (deno)
• awesome-list - ssgo

README

        


  



# ssgo

The minimalistic but flexible static site generator.

**`ssgo`** is built with Deno and relies on it.

![license: MIT](https://img.shields.io/github/license/mdubourg001/ssgo?style=flat-square)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

![netlify: passing](https://img.shields.io/netlify/d9dae2e0-b3b2-4c86-aee8-7a625de6e18a?style=flat-square)

## Documentation

Read the documentation at https://ssgo.netlify.app/docs.

## Quickstart

To install `ssgo` using Deno:

```bash

deno install --unstable --allow-read --allow-write --allow-net --allow-run -q https://deno.land/x/ssgo/ssgo.ts

```

**To create a `ssgo` project** just run:

```bash

mkdir my-ssgo-project && cd my-ssgo-project

ssgo init

```

Here's what a `ssgo` project looks like:

```plaintext

├── creators/    <- here go the scripts creating your pages

├── templates/   <- here go the templates of your pages

├── components/  <- here go your custom components

└── static/      <- here go your static files

```

**To launch a build**: just run:

```bash

ssgo

```

Your site will be built inside of the `dist/` directory.

**To start development mode** with file watching, and a hot reloaded dev server:

```bash

ssgo dev

```

The `dist/` directory will be served over `http://localhost:5580`.

## Overview

`ssgo` basically relies on two types of files: **templates**, and **creators**.

**Templates** are the skeleton of your pages and are simply HTML files living inside the `templates/` directory (and its subdirectories):

```html

  

    

    

    {{ title }}

    

  

  

    
Hello, ssgo !

    
Just run ssgo dev to get started !

  


```

**Creators** are like page factories. Using a `buildPage` function given by `ssgo`, they use **templates** and datas to build pages. Creators live in the `creators/` directory (and its subdirectories):

```typescript

// creators/my-creator.ts

import type { BuildPage } from "https://deno.land/x/ssgo/mod.ts"

import { fetchTitle } from "../src/api.ts"

export default async function (buildPage: BuildPage) {

  const title = await fetchTitle()

  buildPage(

    "my-template.html" // template to use to build the page,

    { title: title } // data to use to build the page,

    { filename: "index.html", dir: "" } // build options

  )

}

```

`ssgo` also provides much more cool stuffs like components, automatic static files management, or just-in-time page build in dev mode. You can learn more about all this things by [reading the documentation](https://ssgo.netlify.app/docs).

## Roadmap

- [ ] Pass undefined if variable doesn't exist when passing props

- [ ] Use CWD's `.tsconfig.json` for typescript compilation if exists

- [ ] Add a support for a config file (.ssgorc, ssgo.config.js)

- [ ] Provide a way to opt out of static ressources resolution on a per-file basis