https://github.com/jridgewell/minx

A completely static site generator powered by JS+JSX
https://github.com/jridgewell/minx

Last synced: about 2 months ago
JSON representation

A completely static site generator powered by JS+JSX

• Host: GitHub
• URL: https://github.com/jridgewell/minx
• Owner: jridgewell
• License: mit
• Created: 2022-01-07T10:12:27.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-10T07:02:36.000Z (almost 3 years ago)
• Last Synced: 2024-10-19T18:31:00.261Z (2 months ago)
• Language: JavaScript
• Homepage: https://justin.ridgewell.name/minx/
• Size: 75.2 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @jridgewell/minx

> A completely static site generator powered by JS+JSX

Static website generators are far too complicated. I don't want to learn

how to configure the site to get it running, I just want to write basic

HTML. But, then I want to avoid duplicate a bunch code when I reuse a

section. If only there were a way to program in JS and build static

HTML…

Minx gives you the full power of JS to create a completely static site.

Each file needs to export just a `default` function in ESM, and its

return value will be interpreted as Preact JSX and used to generate your

HTML.

```jsx

// website/index.mjs

export default function Website() {

  return 

    

      Hello World!

    

  ;

}

```

## Installation

```bash

$ npm install -g @jridgewell/minx

```

## Usage

Basic usage is as follows:

```bash

$ minx build [--in ] [--out ]

$ minx serve [--in ] [--port ]

```

See each command's help message for full options.