SquibView Documentation

Welcome to the SquibView documentation! This directory contains comprehensive documentation for the SquibView library.

Documentation Structure

📚 API Reference

Complete API documentation for SquibView classes and methods.

SquibView Class - Main editor class
Methods - All public methods
Options - Configuration options
Events - Event system reference

📖 Guides

Step-by-step guides and tutorials.

Getting Started
Installation
Headless Mode - Using SquibView without UI
Programmer’s Guide - Comprehensive usage guide

🔧 Development

Documentation for contributors and developers.

📝 Examples

Code examples and demos.

🖥️ CLI Documentation

Command-line interface documentation.

CLI Guide - Using the squibv CLI tool
CLI Readme - Quick reference

📋 Other Documentation

Release Notes - Complete version history and changelog
Selection API - Working with text selection
UMD Build Configuration - Build setup guide

Quick Links

Repository:GitHub
NPM Package:squibview
CDN: Available via jsDelivr and unpkg

Getting Started

Installation

npm install squibview

Basic Usage

importSquibViewfrom'squibview';
import'squibview/dist/squibview.css';

const editor = newSquibView('#editor', {
  initialContent: '# Hello World',
  inputContentType: 'md',
  initialView: 'split'
});

CDN Usage

<!-- CSS --><linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/squibview/dist/squibview.min.css"><!-- JavaScript --><scriptsrc="https://cdn.jsdelivr.net/npm/squibview/dist/squibview.umd.min.js"></script><script>const editor = newSquibView('#editor');
</script>

Features

Multi-format Support: Markdown, HTML, RevealJS presentations, CSV/TSV
Live Preview: Real-time rendering with split-screen view
Syntax Highlighting: Code block highlighting with highlight.js
Diagrams: Mermaid diagram support
Math: LaTeX math rendering with MathJax
Maps: GeoJSON/TopoJSON visualization
3D Models: STL file viewing
Revision History: Undo/redo with diff-based history
Copy Support: Smart clipboard operations
Line Numbers: Optional line numbering
Plugin System: Extensible renderer architecture

Version

See [release-notes]/(./docs/release-notes.md)

License

MIT License - See LICENSE for details

Support

For issues, questions, or contributions, please visit the GitHub repository.