Quick Start

Get SquibView running in just a few minutes!

CLI Quick Start

The fastest way to see SquibView in action is using the CLI tool:

npx squibv document.md

This will generate an HTML file from your Markdown document with all features enabled.

Example

# Create a sample markdown fileecho"# Hello SquibView\n\nThis is **bold** text.\n\n\`\`\`mermaid\nflowchart TD\n    A[Start] --> B[Process]\n    B --> C[End]\n\`\`\`" > sample.md

# Convert to HTML
npx squibv sample.md

# Open sample.html in your browser

Component Quick Start

For web applications, the easiest setup uses autoload:

<!DOCTYPE html><html><head><title>SquibView Example</title><linkrel="stylesheet"href="https://unpkg.com/squibview/dist/squibview.min.css"></head><body><divid="editor"style="height: 500px;"></div><scripttype="module">importSquibViewfrom'https://unpkg.com/squibview/dist/squibview.esm.min.js';

        const editor = newSquibView('#editor', {
            initialContent: '# Hello World\n\nThis is **SquibView** in action!\n\n```mermaid\ngraph TD\n  A --> B\n```',
            autoload_deps: { all: true }  // Enable autoloading
        });
    </script></body></html>

Libraries like Mermaid, MathJax, and syntax highlighting load automatically when needed!

Next Steps