Agave-generator NPM

Minimal markdown to HTML for static sites with pretty URLs.

☀️ Install

yarn global add agave-generator

🍯 Use

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.

agave --help

🏜 Themes

Simply pass the -t argument and the theme name

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.

touch markdown/base.html
touch markdown/styles.css
echo "<html><!-- MARKDOWN --></html>" > markdown/base.html
agave # run the generator again

Here is an example of using custom base.html.

Blog

Repo

📂 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

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. g

🧪 Run your site locally (Coming soon)

agave -s
# 🏃‍♀️ Running on localhost:8080

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

Want to support this project?

  /* let _resp = Response.add_header(~name="content-security-policy", ~value="default-src 'self' style-src 'self' 'unsafe-inline';") */

@everything-registry/sub-chunk-1105 @zalastax/nolb-aga

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago