The SquibView CLI (squibv) is a command-line tool that converts Markdown files into high-quality HTML documents using SquibView’s powerful rendering engine. It supports all the advanced features that make SquibView special, including math expressions, Mermaid diagrams, CSV tables, SVG graphics, and syntax-highlighted code blocks.
Unlike basic markdown converters, SquibView CLI provides:
# No installation required - run directly
npx squibv document.md
npm install -g squibview
squibv document.md
npm install squibview
npx squibv document.md
# Convert markdown to HTML
squibv document.md
# Specify output file
squibv document.md -o report.html
# Use alias command
squibv build document.md -o report.html
# Bundle all dependencies offline (4MB+ but fully self-contained)
squibv document.md --bundle-offline
# Custom CSS styling
squibv document.md --css custom-theme.css
# Watch for changes and rebuild automatically
squibv document.md --watch
squibv <file.md> # Convert markdown file
squibv build <file.md> # Explicit build command
squibv --help# Show help
squibv --version # Show version| Option | Short | Description | Default |
|---|---|---|---|
--input <source> | -i | Input source (file path or “-” for stdin) | Positional argument |
--output <dest> | -o | Output destination (file path, “-” or “stdout” for stdout) | input.html |
--standalone | -s | Create self-contained HTML | true |
--css <file> | Custom CSS file | Default styles | |
--bundle-offline | Bundle all libraries locally | CDN links | |
--log <file> | Log file for messages | stderr | |
--quiet | Suppress progress messages | Off | |
--watch | -w | Watch file and rebuild on changes | Off |
# Basic conversion
squibv README.md
# Professional report with custom styling
squibv report.md --css corporate-theme.css -o quarterly-report.html
# Academic paper with offline bundling
squibv research-paper.md --bundle-offline -o paper.html
# Live development with auto-rebuild
squibv documentation.md --watch
# Custom output location
squibv src/docs/api.md -o dist/api-docs.html
# Read from stdin, write to stdoutcat document.md | squibv -i - -o - > output.html
# Clean pipeline (no progress messages)
curl -s https://api.github.com/repos/user/repo/readme | \
jq -r .content | base64 -d | \
squibv -i - -o - --quiet > readme.html
# Chain with compressioncat report.md | squibv -i - -o - | gzip > report.html.gz
# Process with logging
squibv document.md --log conversion.log --quiet
# Build all documentationfor file in docs/*.md; do
squibv "$file" -o "dist/$(basename "$file" .md).html" --log build.log
done# Generate offline documentation package
squibv documentation.md --bundle-offline -o standalone-docs.html
# Pipeline processing in CI
find docs/ -name "*.md" | \
xargs -I {} squibv {} --log ci.log --quiet
SquibView CLI supports all the advanced features of the SquibView editor:
Inline math: $E = mc^2$
Display math:
$$\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}$$
Fenced math blocks:
\`\`\`math
\\begin{pmatrix}
a & b \\\\
c & d
\\end{pmatrix}
\`\`\`
\`\`\`mermaid
graph TD
A[Start] --> B{Decision}
B --> C[Option 1]
B --> D[Option 2]
\`\`\`
\`\`\`csv
Name,Age,City
Alice,30,New York
Bob,25,Los Angeles
\`\`\`
\`\`\`tsv
Name Age City
Alice 30 New York
\`\`\`
\`\`\`svg
<svgwidth="200"height="100"><circlecx="50"cy="50"r="40"fill="blue" /></svg>
\`\`\`
\`\`\`javascript
function greet(name) {
console.log(\`Hello, \${name}!\`);
}
\`\`\`
squibv document.mdsquibv document.md --bundle-offlineSquibView CLI includes professional default styles:
# Override with custom styles
squibv document.md --css my-theme.css
Example custom CSS:
/* Override default styles */body {
font-family: 'Georgia', serif;
background-color: #f8f9fa;
}
h1, h2, h3 {
color: #2c3e50;
}
.mermaid {
background-color: white;
border: 1px solid #ddd;
border-radius: 8px;
padding: 1rem;
}
name: Generate Documentation
on: [push]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- run: npx squibv README.md -o docs/index.html
- run: npx squibv API.md --bundle-offline -o docs/api.html
{"scripts":{"docs":"squibv README.md -o dist/documentation.html","docs:watch":"squibv README.md --watch","docs:offline":"squibv README.md --bundle-offline -o standalone.html"}}docs: README.md
squibv README.md -o docs/index.html
docs-offline: README.md
squibv README.md --bundle-offline -o docs/offline.html
.PHONY: docs docs-offline
File not found errors
# Use absolute paths if needed
squibv /full/path/to/document.md
Permission errors
# Check file permissionsls -la document.md
chmod 644 document.md
Large file sizes with --bundle-offline
Math not rendering
Mermaid diagrams not showing
--bundle-offline for maximum reliabilityFor more information about SquibView’s web editor capabilities, see the main README.