{"id":13726600,"url":"https://github.com/jottenlips/agave","last_synced_at":"2026-02-15T22:09:20.233Z","repository":{"id":55790454,"uuid":"299065491","full_name":"jottenlips/agave","owner":"jottenlips","description":" 🍯 Sweet simple static site generator","archived":false,"fork":false,"pushed_at":"2024-12-31T19:31:23.000Z","size":201,"stargazers_count":13,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-05T16:38:07.049Z","etag":null,"topics":["agave","agave-generator","dune","github-pages","hacktoberfest","hacktoberfest2020","html","markdown","md","microblog","npm","ocaml","opam","reasonml","ssg","static-site","static-site-generator","themes"],"latest_commit_sha":null,"homepage":"https://jottenlips.github.io/","language":"Reason","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jottenlips.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":null,"open_collective":null,"ko_fi":"johnottenlips","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-09-27T15:51:06.000Z","updated_at":"2024-12-31T19:31:26.000Z","dependencies_parsed_at":"2024-01-06T07:44:53.361Z","dependency_job_id":null,"html_url":"https://github.com/jottenlips/agave","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jottenlips%2Fagave","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jottenlips%2Fagave/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jottenlips%2Fagave/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jottenlips%2Fagave/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jottenlips","download_url":"https://codeload.github.com/jottenlips/agave/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248512851,"owners_count":21116690,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agave","agave-generator","dune","github-pages","hacktoberfest","hacktoberfest2020","html","markdown","md","microblog","npm","ocaml","opam","reasonml","ssg","static-site","static-site-generator","themes"],"created_at":"2024-08-03T01:03:14.238Z","updated_at":"2026-02-15T22:09:20.227Z","avatar_url":"https://github.com/jottenlips.png","language":"Reason","funding_links":["https://ko-fi.com/johnottenlips"],"categories":["Reason"],"sub_categories":[],"readme":"![Agave Logo](logo.gif)\n\nMinimal markdown to HTML for static sites with pretty URLs.\n\nWritten in [ReasonML](https://reasonml.github.io/) with native OCaml toolchain (opam + dune).\n\n## Install\n\n### Via npm\n\n```\nnpm install -g agave-generator\n```\n\n### Build from source\n\nRequires [opam](https://opam.ocaml.org/) and OCaml 5.1+.\n\n```console\nopam install . --deps-only -y\ndune build\ndune install\n```\n\n### Link locally for development\n\n```console\nopam install . --deps-only -y\ndune build\ncp _build/default/bin/Agave.exe bin/agave-native\nnpm link --ignore-scripts\n```\n\nNow `agave` is available globally. To unlink:\n\n```console\nnpm unlink -g agave-generator\n```\n\n## Use\n\n```console\nmkdir blog\ncd blog\nmkdir markdown\ntouch markdown/index.md # home page\ntouch markdown/first-post.md # /first-post/ route\nagave # reads all your readmes in ./markdown and outputs them to ./public\n```\n\nFor the full list of options run `help`.\n\n```console\nagave --help\n```\n\n## Themes\n\nSimply pass the -t argument and the theme name\n\n```console\nagave -t desert\n```\n\n## Full Customization\n\nIf you didn't find a theme for you you can add any base HTML and CSS you would like.\n\nbase.html will wrap every generated page.\n\nbase.html must contain `\u003c!-- MARKDOWN --\u003e` where you would like your content placed.\n\nIf you have a `styles.css` file in the markdown folder, it will be copied to the deployment folder.\n\n```console\ntouch markdown/base.html\ntouch markdown/styles.css\necho \"\u003chtml\u003e\u003c!-- MARKDOWN --\u003e\u003c/html\u003e\" \u003e markdown/base.html\nagave # run the generator again\n```\n\nHere is an example of using custom `base.html`.\n\n[Blog](https://jottenlips.github.io/)\n\n[Repo](https://github.com/jottenlips/jottenlips.github.io)\n\n## File structure\n\n```\n./markdown\n└──base.html\n└──index.md\n└──another-page.md\n└──topic.md\n└──/topic\n    └──2019-1-1.md\n    └──2020-1-1.md\n    └──2021-1-1.md\n```\n\nresults in\n\n```\n./public\n└──index.html\n└──another-page/index.html\n└──/topic\n    └──index.html\n    └──2019-1-1/index.html\n    └──2020-1-1/index.html\n    └──2021-1-1/index.html\n```\n\n## Deploy your site\n\nGithub Pages\n\n```console\nagave --markdown myblog --public docs\ngit add --all\ngit commit -m\"deploy\"\ngit push\n```\n\nSetup your repo to look at the docs folder on your main branch in the repo settings.\n\n## Run your site locally\n\n```console\nagave -s\n# Server running at http://localhost:8080/\n```\n\nYou can also serve any existing directory without generating:\n\n```console\nagave -p ./docs -s\n```\n\n## Release\n\n1. Commit and tag:\n\n```console\ngit add -A \u0026\u0026 git commit -m \"v0.2.0: description\"\ngit tag v0.2.0\ngit push origin main --tags\n```\n\n2. GitHub Actions builds native binaries for `linux-x64`, `darwin-x64`, and `darwin-arm64` and attaches them to a GitHub Release.\n\n3. Publish to npm:\n\n```console\nnpm publish\n```\n\n## Support\n\nWant to support this project?\n\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjottenlips%2Fagave","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjottenlips%2Fagave","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjottenlips%2Fagave/lists"}