agave-generator
Advanced tools
Minimal markdown to HTML for static sites with pretty URLs.
yarn global add agave-generator
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
Simply pass the -t argument and the theme name
agave -t desert
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 <!-- MARKDOWN --> 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.
./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
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
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';") */
FAQs
Simple static site generator
We found that agave-generator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.