Expand description
Node.js bindings for Ox Content.
This crate provides NAPI bindings for using Ox Content from Node.js, enabling zero-copy AST transfer and JavaScript interoperability.
Structs§
- JsOg
Image Config - OG image configuration for JavaScript.
- JsOg
Image Data - OG image data for JavaScript.
- JsParser
Options - Parser options for JavaScript.
- JsSearch
Document - Search document for JavaScript.
- JsSearch
Options - Search options for JavaScript.
- JsSearch
Result - Search result for JavaScript.
- JsSsg
Config - SSG configuration.
- JsSsg
NavGroup - Navigation group for SSG.
- JsSsg
NavItem - Navigation item for SSG.
- JsSsg
Page Data - Page data for SSG.
- JsTransform
Options - Transform options for JavaScript.
- Parse
AndRender Task - Async task for parse_and_render.
- Parse
Result - Parse result containing the AST as JSON.
- Render
Result - Render result containing the HTML output.
- TocEntry
- Table of contents entry.
- Transform
Result - Transform result containing HTML, frontmatter, and TOC.
- Transform
Task - Async task for transform.
Functions§
- build_
search_ index - Builds a search index from documents.
- extract_
search_ content - Extracts searchable content from Markdown source.
- generate_
og_ image_ svg - Generates an OG image as SVG.
- generate_
ssg_ html - Generates SSG HTML page with navigation and search.
- parse
- Parses Markdown source into an AST.
- parse_
and_ render - Parses Markdown and renders to HTML.
- parse_
and_ render_ async - Parses Markdown and renders to HTML asynchronously (runs on worker thread).
- render
- Renders an AST (provided as JSON) to HTML.
- search_
index - Searches a serialized index.
- transform
- Transforms Markdown source into HTML, frontmatter, and TOC.
- transform_
async - Transforms Markdown source asynchronously (runs on worker thread).
- version
- Returns the version of ox_content_napi.