Skip to content

xberg-io/html-to-markdown / .ai-rulez/skills/crate-structure

crate-structure

Verified

Map of the html-to-markdown workspace: crates/, packages/ and the convert() API with its result shape and feature flags. Use when navigating crates or packages, deciding where code belongs, or calling convert().

Crate & Package Structure

Workspace members (root Cargo.toml)

  • crates/html-to-markdown — core library and primary Rust API
  • crates/html-to-markdown-cli — CLI binary (clap)
  • crates/html-to-markdown-ffi — C FFI bridge with cbindgen headers
  • crates/html-to-markdown-py — PyO3 Python binding
  • crates/html-to-markdown-node — NAPI-RS Node/TypeScript binding
  • crates/html-to-markdown-php — ext-php-rs PHP binding
  • crates/html-to-markdown-rs-jni — JNI binding
  • crates/html-to-markdown-wasm — wasm-bindgen WebAssembly binding
  • packages/dart/rust, packages/swift/rust, tools/benchmark-harness
  • Workspace lints set unsafe_code = "forbid"; only the core and CLI crates inherit them ([lints] workspace = true).

Language packages (packages/)

  • csharp/, dart/, elixir/, go/, java/, kotlin-android/, php/, python/, r/, ruby/, swift/, zig/

Primary API

  • convert(html: &str, options: impl Into<Option<ConversionOptions>>) -> Result<ConversionResult> in crates/html-to-markdown/src/convert_api.rs
  • ConversionResult: content, document, tables, warnings; metadata with the metadata feature, images with inline-images
  • Feature flags: metadata (default), inline-images, visitor (caller traversal hooks), serde, mcp, mcp-http, full
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 319kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 319kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 319kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 319kUpdated Claude CodeCodexVerifiedInstall