https://github.com/leostera/cactus

🌵A composable static site generator
https://github.com/leostera/cactus

blazingly-fast build-system composable-infrastructure desert markdown ocaml reasonml static-site-generator

Last synced: 3 months ago
JSON representation

🌵A composable static site generator

• Host: GitHub
• URL: https://github.com/leostera/cactus
• Owner: leostera
• Created: 2018-12-14T23:26:08.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-26T11:29:17.000Z (over 4 years ago)
• Last Synced: 2024-05-02T06:18:22.857Z (9 months ago)
• Topics: blazingly-fast, build-system, composable-infrastructure, desert, markdown, ocaml, reasonml, static-site-generator
• Language: Reason
• Homepage:
• Size: 185 KB
• Stars: 65
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🌵 Cactus — A composable static site generator

Cactus is a reaction to the amount of static site generators out there

that enforce their structures on you. Cactus does very little. If you open it

up, you'll find it's full of water.

### Installing

`cactus` builds with Esy just fine. Make sure to have `libev-dev` installed tho!

```sh

esy

esy build

esy x cactus

```

## Getting Started

Cactus works in a very simple way. In fact it's almost silly how simple it is.

If you put a `cactus-project` file on the root of your project, cactus will look

throughout your whole project for `site` files.

`site` files simply tell `cactus` that this particular folder should be compiled

into a website.

So if you have your posts in the following structure:

```sh

my/website λ tree

.

├── pages

│   ├── First-post.md

│   └── Some-other-post.md

└── sections

    ├── about.md

    ├── hire-me.md

    └── projects.md

```

You just need to `touch` a few files:

```sh

my/website λ touch cactus-project

my/website λ touch pages/site sections/site

```

And you can run `cactus` to compile the website using the same tree structure

under a `_public` folder:

```sh

my/website λ cactus build

🌵 Compiling project...

🌮 Done in 0.002s

my/website  λ tree

.

├── _public

│   ├── pages

│   │   ├── First-post.html

│   │   └── Some-other-post.html

│   └── sections

│       ├── about.html

│       ├── hire-me.html

│       └── projects.html

├── cactus-project

├── pages

│   ├── First-post.md

│   ├── Some-other-post.md

│   └── site

└── sections

    ├── about.md

    ├── hire-me.md

    ├── projects.md

    └── site

```

Which you can readily serve however you feel like. Upload to S3, Now, GCS,

Github pages, or pretty much wherever.

When in doubt, check out the `example` folder. All of the features will be

showcased there.

### Templating

You'll quickly notice that the bare compilation from Markdown to HTML doesn't

quite fit all use-cases. To alleviate this `cactus` lets you specify in your

`site` file a template file to be used for all the Markdown files within that

specific site.

Say you wanted to wrap all of the pages from the example above in a common

markup: add a `` to all of them. You'd write a template

file:

```html

  

    

  

  

    {| document |}

  

```

And in your `site` file you'd point to it:

```lisp

(template "path/to/template.html")

```

Voila! That's all it takes to get the templating up and running. It's very basic

at the moment, but it'll get you quite far! The next step is to provide better

support for building pages with arbitrary logic, possibly by letting you specify

a module to be used for processing each file.

### Assets

To copy assets (any supporting file to your site) you can use the `(assets

...)` rule:

```lisp

(assets

  style.css

  logo.svg

  bg_music.midi)

```

And they will be automatically copied from their location, relative to the

`site` file.

You can also use the shorthand `.` instead of listing your assets to have all

the files in the folder copied over. This is not recursive.