{"id":18510041,"url":"https://github.com/lfex/poise","last_synced_at":"2025-04-09T04:33:03.223Z","repository":{"id":67235682,"uuid":"82692923","full_name":"lfex/poise","owner":"lfex","description":"An LFE Library for framework-agnostic generation of static HTML content","archived":false,"fork":false,"pushed_at":"2024-01-08T03:42:29.000Z","size":923,"stargazers_count":8,"open_issues_count":3,"forks_count":0,"subscribers_count":4,"default_branch":"release/0.3.x","last_synced_at":"2025-03-23T23:15:22.598Z","etag":null,"topics":["erlang","generator","html","http","lfe","lmug","sites","static","web"],"latest_commit_sha":null,"homepage":"","language":"LFE","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lfex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-21T15:04:04.000Z","updated_at":"2024-08-02T14:11:22.000Z","dependencies_parsed_at":"2024-11-06T15:32:14.723Z","dependency_job_id":null,"html_url":"https://github.com/lfex/poise","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lfex%2Fpoise","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lfex%2Fpoise/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lfex%2Fpoise/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lfex%2Fpoise/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lfex","download_url":"https://codeload.github.com/lfex/poise/tar.gz/refs/heads/release/0.3.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247953106,"owners_count":21023947,"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":["erlang","generator","html","http","lfe","lmug","sites","static","web"],"created_at":"2024-11-06T15:20:20.151Z","updated_at":"2025-04-09T04:33:03.139Z","avatar_url":"https://github.com/lfex.png","language":"LFE","funding_links":[],"categories":[],"sub_categories":[],"readme":"# poise\n\n[![Build Status][gh-actions-badge]][gh-actions]\n[![LFE Versions][lfe-badge]][lfe]\n[![Erlang Versions][erlang-badge]][versions]\n[![Tag][github-tag-badge]][github-tag]\n\n[![Project Logo][logo]][logo-large]\n\n*An LFE Library for framework-agnostic generation of static HTML content*\n\n\n#### Contents\n\n* [About](#about-)\n* [Prerequisites](#prerequisites-)\n* [Usage](#usage-)\n* [Name](#name-)\n* [License](#license-)\n\n\n## About [\u0026#x219F;](#contents)\n\nThis project is getting an overhaul to allow for better control over rendered Markdown in static sites. Progress is being tracked here:\n\n* [poise redesign](https://github.com/lfex/poise/issues/8)\n\n`poise` aims to be as simple and unopinionated solution as possible to the\nproblem of generating static site content in the LFE/Erlang/BEAM world of web\ndevelopment. \n\nWhile early versions of the poise LFE library were inspired by the Clojure\n[statis](https://github.com/magnars/stasis), in more recent years the Rust-based project [Zola](https://github.com/getzola/zola) has informed our design decisiions (in particular the areas where we found it inflexible).\n\n## Prerequisites [\u0026#x219F;](#contents)\n\nBefore building with `rebar3`, one needs to have the following installed:\n\n* `gcc`, `make`, and related tools (also `git`)\n* The Rust build tool `cargo` preferably installed using [rustup](https://rustup.rs/)\n* The Markdown AST-parser `mdsplode` (installed using `cargo`)\n* The `jq` and `oniguruma` libraries (used for querying JSON)\n* Erlang and `rebar3`\n\nTo set up the environment variables required by [mdsplod](https://crates.io/crates/mdsplode), you need to follow the instructions provided [here](https://github.com/oxur/mdsplode/blob/release/0.4.x/docs/jq-support.md). Once that's done, you will be able to run the following:\n\n``` shell\ncargo install mdsplode\nrebar3 compile\nrebar3 lfe repl\n```\n\n## Usage [\u0026#x219F;](#contents)\n\nYou can start `poise` in the LFE REPL with the following:\n\n``` lisp\n(poise:start)\n```\n\nThe following are useful to check that the Rust binary is working with LFE:\n\n``` lisp\n(sploder:version)\n(sploder:ping)\n(sploder:echo \"this is a test\")\n```\n\nYou can use a test file to check out some of the content-parsing functionality:\n\n``` lisp\n(sploder:read 'md \"priv/testing/learn.md\"))\n(sploder:frontmatter)\n(sploder:query \"'.children.nodes[] | select((.depth == 3) and .source == \\\"Getting Started\\\")'\")\n```\n\n## Name [\u0026#x219F;](#contents)\n\n\u003cem\u003e\u003cstrong\u003epoise\u003c/strong\u003e\u003c/em\u003e, n. \u003csup\u003e[1](#footnote1)\u003c/sup\u003e\n\n1. a stably balanced state; equilibrium\n1. easy self-possessed assurance of manner; gracious tact in coping or\n   handling; the pleasantly tranquil interaction between persons of poise; a\n   particular way of carrying oneself; bearing, carriage\n\n## License [\u0026#x219F;](#contents)\n\nCopyright © 2017-2024, Duncan McGreggor\n\nApache License, Version 2.0\n\n\n----\n\u003ca name=\"footnote1\"\u003e1\u003c/a\u003e\n[https://www.merriam-webster.com/dictionary/poise](https://www.merriam-webster.com/dictionary/poise)\n\n\n[//]: ---Named-Links---\n\n[logo]: https://raw.githubusercontent.com/lfex/poise/main/priv/images/logo.png\n[logo-large]: https://raw.githubusercontent.com/lfex/poise/main/priv/images/logo-large.png\n[org]: https://github.com/lfex\n[github]: https://github.com/lfex/poise\n[gh-actions-badge]: https://github.com/lfex/poise/workflows/ci%2Fcd/badge.svg\n[gh-actions]: https://github.com/lfex/poise/actions\n[lfe]: https://github.com/lfe/lfe\n[lfe-badge]: https://img.shields.io/badge/lfe-2.1+-blue.svg\n[erlang-badge]: https://img.shields.io/badge/erlang-23+-blue.svg\n[versions]: https://github.com/lfex/poise/blob/master/.github/workflows/cicd.yml\n[github-tag]: https://github.com/lfex/poise/tags\n[github-tag-badge]: https://img.shields.io/github/tag/lfex/poise.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfex%2Fpoise","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flfex%2Fpoise","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfex%2Fpoise/lists"}