authorgravatar for git@paperclover.netclover caruso <git@paperclover.net> 2026-02-16 01:59:17-08:00
committergravatar for git@paperclover.netclover caruso <git@paperclover.net> 2026-02-16 20:08:44-08:00
logcdd0952e19e387d2530aa684e361ddc0b1d64967
treef04429b8b1b6be2012781f6da021f4a91c9bbf27
parent1028bc4c2ba5bf5656b06c29ea8ba019f548df05
signaturebadge-check Signed by SSH key SHA256:xbd+BjjhyBfwk7GVoURf9Yx0gzDerHbvYv7SddNWmAs

chore: readme stuff

1 files changed, 11 insertions(+), 8 deletions(-)

README.md+11-8
...@@ -39,7 +39,7 @@ meta:...@@ -39,7 +39,7 @@ meta:
3939
40# ${meta.title}40# ${meta.title}
4141
42i'm a catgirl and i love to **meow**! meow meow meow! 42i'm a catgirl and i love to **meow**! <rainbow-text>meow meow meow!</>
4343
44```ts44```ts
45function doMyFavoriteThing() {45function doMyFavoriteThing() {
...@@ -73,11 +73,12 @@ i love being alive. ${'<3'} from ${new Date().getFullYear()}....@@ -73,11 +73,12 @@ i love being alive. ${'<3'} from ${new Date().getFullYear()}.
7373
74## Install74## Install
7575
76Markodown is distributed on [NPM](http://npmjs.com/markodown) and76Markodown is distributed on [NPM](https://npmjs.com/package/markodown) and
77[JSR](https://jsr.io/@clo/markodown). The compiler runs anywhere JS+WASM runs.77[JSR](https://jsr.io/@clo/markodown). The compiler runs anywhere JS+WASM runs.
7878
79```sh79```sh
80npm i markodown80npm i markodown
81# or
81npx jsr add @clo/markodown82npx jsr add @clo/markodown
82```83```
8384
...@@ -97,6 +98,7 @@ export default defineConfig({...@@ -97,6 +98,7 @@ export default defineConfig({
97 // optionally wrap all markdown files in a layout, this component is98 // optionally wrap all markdown files in a layout, this component is
98 // given a list of headers to construct a table of contents.99 // given a list of headers to construct a table of contents.
99 layoutImport: "../tags/markdown-layout.marko",100 layoutImport: "../tags/markdown-layout.marko",
101 // ...more customization options are well-documented in the types.
100 }),102 }),
101 ],103 ],
102});104});
...@@ -104,7 +106,7 @@ export default defineConfig({...@@ -104,7 +106,7 @@ export default defineConfig({
104106
105## Components107## Components
106108
107All Marko features, such as [tag resolution], [attribute tags],109All Marko features are supported, such as [tag resolution], [attribute tags],
108[class shorthands], and template expressions. This makes it so much easier to110[class shorthands], and template expressions. This makes it so much easier to
109add complex content to your pages.111add complex content to your pages.
110112
...@@ -130,7 +132,7 @@ You can use Markodown to write blogs and long documents, then extract a table of...@@ -130,7 +132,7 @@ You can use Markodown to write blogs and long documents, then extract a table of
130contents. This is done with two mechanisms.132contents. This is done with two mechanisms.
131133
132- `layoutImport` which wraps the entire document in a component, which is given134- `layoutImport` which wraps the entire document in a component, which is given
133 three attributes.135 three attributes. (see typescript types on the plugin / `transform` function)
134 - `content`: the rendered content.136 - `content`: the rendered content.
135 - `module`: the module namespace for the compiled Markodown file.137 - `module`: the module namespace for the compiled Markodown file.
136 - `outline`: an array of `Heading` objects.138 - `outline`: an array of `Heading` objects.
...@@ -212,7 +214,8 @@ this paragraph gets wrapped in a `<p>` tag!...@@ -212,7 +214,8 @@ this paragraph gets wrapped in a `<p>` tag!
212214
213## Static Statements215## Static Statements
214216
215Define module-level functions and variables.217You can define module-level functions and variables,
218[same as you can in Marko](https://markojs.com/docs/reference/language#statements).
216219
217```220```
218static function sort(items: string[]) {221static function sort(items: string[]) {
...@@ -229,9 +232,9 @@ Note that this means writing a paragraph starting with the lowercase words...@@ -229,9 +232,9 @@ Note that this means writing a paragraph starting with the lowercase words
229```232```
230# All About RSC233# All About RSC
231234
232\server components are stupid. (markdown backslash)235\server components are a bad idea. (markdown backslash)
233236
234${"server"} components are stupid. (template literal)237${"server"} components are a bad idea. (template literal)
235238
236Though you can say import as long as its not the first item.239Though you can say import as long as it's not the first item.
237```240```