Add documentation

packages/content/README.md

@@ -1,11 +1,29 @@
 # @welshman/content [![version](https://badgen.net/npm/v/@welshman/content)](https://npmjs.com/package/@welshman/content)
 
-Utilities for parsing note content.
+Utilities for parsing and rendering note content. Customizable via RenderOptions.
 
 ```typescript
 import {parse, render} from '@welshman/content'
 
 const content = "Hello<br>from https://coracle.tools! <script>alert('evil')</script>"
-const html = parse({content}).map(render).join("")
+const parsed = parse({content, tags: []})
+// [
+//   { type: 'text', value: 'Hello<br>from ', raw: 'Hello<br>from ' },
+//   {
+//     type: 'link',
+//     value: { url: URL, isMedia: false },
+//     raw: 'https://coracle.tools'
+//   },
+//   {
+//     type: 'text',
+//     value: "! <script>alert('evil')</script>",
+//     raw: "! <script>alert('evil')</script>"
+//   }
+// ]
+
+const result = renderAsText(parsed)
+// => Hello&lt;br&gt;from https://coracle.tools/! &lt;script&gt;alert('evil')&lt;/script&gt;
+
+const result = renderAsHtml(parsed)
 // => Hello&lt;br&gt;from <a href="https://coracle.tools/" target="_blank">coracle.tools/</a>! &lt;script&gt;alert('evil')&lt;/script&gt;
 ```

packages/content/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}