https://github.com/jottenlips/agave

🍯 Sweet simple static site generator
https://github.com/jottenlips/agave

agave agave-generator dune github-pages hacktoberfest hacktoberfest2020 html markdown md microblog npm ocaml opam reasonml ssg static-site static-site-generator themes

Last synced: 24 days ago
JSON representation

🍯 Sweet simple static site generator

• Host: GitHub
• URL: https://github.com/jottenlips/agave
• Owner: jottenlips
• License: other
• Created: 2020-09-27T15:51:06.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-13T01:18:37.000Z (11 months ago)
• Last Synced: 2024-08-03T01:29:10.975Z (3 months ago)
• Topics: agave, agave-generator, dune, github-pages, hacktoberfest, hacktoberfest2020, html, markdown, md, microblog, npm, ocaml, opam, reasonml, ssg, static-site, static-site-generator, themes
• Language: Reason
• Homepage: https://jottenlips.github.io/
• Size: 194 KB
• Stars: 13
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - agave

README

        
⚠️ This project is moving to [amino](https://github.com/jottenlips/amino-ssg) soon. I am rewriting the core logic in Rust.

# Deprecated: please check out [amino](https://github.com/jottenlips/amino-ssg)

![Agave Logo](logo.gif)

Minimal markdown to HTML for static sites with pretty URLs.

## ☀️ Install

```

yarn global add agave-generator

```

## 🍯 Use

```console

mkdir blog

cd blog

mkdir markdown

touch markdown/index.md # home page

touch markdown/first-post.md # /first-post/ route

agave # reads all your readmes in ./markdown and outputs them to ./public

```

For the full list of options run `help`.

```console

agave --help

```

## 🏜 Themes

Simply pass the -t argument and the theme name

```console

agave -t desert

```

## 🌿 Full Customization

If you didn't find a theme for you you can add any base HTML and CSS you would like.

base.html will wrap every generated page.

base.html must contain `` where you would like your content placed.

If you have a `styles.css` file in the markdown folder, it will be copied to the deployment folder.

```console

touch markdown/base.html

touch markdown/styles.css

echo "" > markdown/base.html

agave # run the generator again

```

Here is an example of using custom `base.html`.

[Blog](https://jottenlips.github.io/)

[Repo](https://github.com/jottenlips/jottenlips.github.io)

## 📂 File structure

```

./markdown

└──base.html

└──index.md

└──another-page.md

└──topic.md

└──/topic

    └──2019-1-1.md

    └──2020-1-1.md

    └──2021-1-1.md

```

results in

```

./public

└──index.html

└──another-page/index.html

└──/topic

    └──index.html

    └──2019-1-1/index.html

    └──2020-1-1/index.html

    └──2021-1-1/index.html

```

## 🧗‍♀️ Deploy your site

Github Pages

```console

agave --markdown myblog --public docs

git add --all

git commit -m"deploy"

git push

```

Setup your repo to look at the docs folder on your main branch in the repo settings.

## 🧪 Run your site locally

```console

# for now, to preview locally

cd public # or docs folder for gh pages

python3 -m http.server 8000

```

### (WIP)

```console

agave -s

# 🏃‍♀️ Running on localhost:8080

```

🐛 TODO: fix CSP so remote images and fonts will show up when running locally.

## 🐪 Support 

Want to support this project?

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K01P2WT)