@draftably/markdown 0.2.0 → 0.2.2

package/README.md

@@ -8,18 +8,35 @@ load no Draftably JavaScript.
 pnpm add @draftably/markdown
 ```
 
-```ts
-import remarkDraft from '@draftably/markdown/remark';
-import { createFileAssets } from '@draftably/markdown/files';
+For a standalone Markdown build, install `markdown-it`, then use the async adapter and write its
+HTML:
 
-const assets = createFileAssets({ directory: '.cache/diagrams', publicPath: '/diagrams/' });
-processor.use(remarkDraft, { emitAsset: assets.emitAsset });
-// After the build: await assets.copyTo('dist/diagrams');
+```sh
+pnpm add @draftably/markdown markdown-it
 ```
 
+````js
+import { mkdir, writeFile } from 'node:fs/promises';
+import MarkdownIt from 'markdown-it';
+import { createMarkdownItDraft } from '@draftably/markdown/markdown-it';
+import { createFileAssets } from '@draftably/markdown/files';
+
+const assets = createFileAssets({ directory: 'dist/diagrams', publicPath: '/diagrams/' });
+const adapter = createMarkdownItDraft({ emitAsset: assets.emitAsset });
+const md = new MarkdownIt().use(adapter.plugin);
+const source = '```draft\ndiagram "API" version=1\nnode api "API"\n```';
+const { html } = await adapter.render(md, source);
+await mkdir('dist', { recursive: true });
+await writeFile('dist/index.html', html);
+````
+
+Run it as an `.mjs` file. This writes `dist/index.html` and the referenced SVG under
+`dist/diagrams/`. For `src` includes, errors, Mermaid fences, caching and interactive mode, use the
+[Markdown guide](https://draftably.dev/docs/markdown).
+
 ## Docs
 
 - [Markdown](https://draftably.dev/docs/markdown): a first build, fence options, includes,
   Mermaid fences and interactive mode
-- [Documentation sites](https://draftably.dev/docs/documentation-sites): Astro Starlight,
-  Docusaurus and VitePress recipes
+- [Documentation sites](https://draftably.dev/docs/documentation-sites): complete Astro Starlight,
+  Docusaurus and VitePress setups, including development serving and build output