Skip to content

Latest commit

 

History

History
105 lines (74 loc) · 3.73 KB

README.md

File metadata and controls

105 lines (74 loc) · 3.73 KB

@thi.ng/transclude

npm version npm downloads Mastodon Follow

Note

This is one of 199 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

About

Extensible functional template engine for text document generation, incl. various high-level Markdown features.

This package evolved from this monorepo's readme generator toolchain and currently is mainly used to generate all ~350 readme & changelog files in this repo, but otherwise is not bound to this project in any way.

Please see /tools/src/readme.ts for a concrete usage example...

Status

STABLE - used in production

Search or submit any issues for this package

Related packages

  • @thi.ng/hiccup-markdown - Markdown parser & serializer from/to Hiccup format
  • @thi.ng/markdown-table - Markdown table formatter/generator with support for column alignments
  • @thi.ng/proctext - Extensible procedural text generation engine with dynamic, mutable state, indirection, randomizable & recursive variable expansions
  • @thi.ng/tangle - Literate programming code block tangling / codegen utility, inspired by org-mode & noweb

Installation

yarn add @thi.ng/transclude

ESM import:

import * as tra from "@thi.ng/transclude";

For Node.js REPL:

const tra = await import("@thi.ng/transclude");

Package sizes (brotli'd, pre-treeshake): ESM: 1.86 KB

Dependencies

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

API

Generated API docs

TODO

Authors

If this project contributes to an academic publication, please cite it as:

@misc{thing-transclude,
  title = "@thi.ng/transclude",
  author = "Karsten Schmidt",
  note = "https://thi.ng/transclude",
  year = 2022
}

License

© 2022 - 2024 Karsten Schmidt // Apache License 2.0