Concepts

Supported stacks

What DocsAlive understands and executes today, engine v0.2.1.

Docs frameworks

FrameworkDetected byTested on
MkDocs (incl. Material tabs)mkdocs.ymlProject A: 24 pages
Mintlify (MDX, <CodeGroup>, <Tabs>)docs.json / mint.jsonProject B: 261 pages
Docusaurus (MDX, <Tabs>)docusaurus.config.*Project C: 24 pages
ReadMe (exported Markdown)rdme.yml / .readme—
Plain Markdown / MDXfallback—

Languages

Fence languageWhat happens
python, pyExecuted in page order; top-level await wrapped automatically
pycon (>>> sessions)Executed line by line; printed output compared with the docs
js, javascript, mjs, cjsExecuted on Node 20 (ESM or CommonJS detected)
ts, typescriptSimple type annotations stripped, then executed. Other TS-only syntax isn't judged
jsx, tsxNot judged yet (classified unsupported-syntax)
bash, sh, shell, consoleExecuted. $ prompts are stripped and output lines told apart
curl, httpRequests sent with curl, including raw HTTP request blocks
json, tomlValidated
Go, Rust, Java, Ruby, PHP, C#, Kotlin, SwiftRecognized but not executed yet (unsupported-lang)

OpenAPI

OpenAPI files found in the repository are parsed. Each $ref is resolved, and operations and examples are counted. On Project B: 68 operations, 87 examples, 0 broken references.

Current limitations

  • Full TypeScript and JSX execution is not available yet.
  • Compiled languages aren't executed yet.
  • Examples that need credentials are classified, not executed with real keys.

Need a stack we don't cover? Tell us. It shapes what we build next.