SciFlow library documentation¶
SciFlow provides npm packages for its web components, core runtime, and schema, along with tools for extending or contributing to the editor. This site contains two guides:
- User guide — for development teams that embed the
<sciflow-editor>component or call the core APIs directly. - Developer guide — for contributors who work in this monorepo with Nx, Vitest, and MkDocs.
Use the navigation on the left to jump into either guide, or start with the summaries below.
Live Demo
Try the editor in your browser → — no install required.
Choose your path¶
| If you want to… | Start here |
|---|---|
| Embed the editor, wire reference lists, or call commands from your app | User Guide |
| Develop the editor, run Nx targets, or extend its schema and features | Developer guide |
| Look up package entry points or schema exports | Reference |
New to the project?
Start with Getting started. It covers registry configuration, package installation, the demo, and embedding the web components.
Contributing internally
The developer guide uses the same commands as CI. Run npx nx run-many -t lint test build typecheck locally before opening a pull request.
What the documentation contains¶
- User guide — Install and configure the components. It includes examples for providing reference lists, file APIs, and document outlines.
- Developer guide — Review the architecture, command system, local workflows, and documentation tools.
- Reference — Look up package entry points, schemas, features, import and export contracts, and renderer behavior. Release notes are in the repository's
CHANGELOG.md, not on this site.
Every page under docs/pages/ is published to the public open-source mirror. Do not include internal URLs or customer or partner names. Add a CHANGELOG.md entry for each change to a published API. Use admonitions such as !!! note and !!! warning to keep important guidance visible.