markdown-it-moss

Markdown-it plugin for rendering Moss spreadsheet blocks in Markdown documents.

Installation

npm install markdown-it-moss
# or
pnpm add markdown-it-moss

Usage

import MarkdownIt from 'markdown-it';
import markdownItMoss from 'markdown-it-moss';

const md = new MarkdownIt();
md.use(markdownItMoss);

const markdown = `
# My Document

\`\`\`moss
---
metadata:
  title: "Sales Data"

cells:
  - A1: "Product"
  - B1: "Revenue"
  - A2: "Widget"
  - B2: 1500
  - A3: "Gadget"
  - B3: 2300
  - A4: "Total"
  - B4: =SUM(B2:B3)
\`\`\`
`;

const html = md.render(markdown);

Options

md.use(markdownItMoss, {
  format: 'html',        // 'html' or 'markdown'
  showErrors: true       // Show error messages in output
});

format

• 'html' (default) - Render as HTML table
• 'markdown' - Render as markdown table

showErrors

• true (default) - Display error messages when Moss parsing fails
• false - Silent failures (returns empty string)

Examples

Basic Table

```moss
---
cells:
  - A1: "Name"
  - B1: "Score"
  - A2: "Alice"
  - B2: 95
  - A3: "Bob"
  - B3: 87
```

With Formulas

```moss
---
metadata:
  title: "Budget Summary"

cells:
  - A1: "Income"
  - B1: 5000
  - A2: "Expenses"
  - B2: 3500
  - A3: "Savings"
  - B3: =B1 - B2
```

With Charts

```moss
---
cells:
  - A1: "Q1"
  - A2: "Q2"
  - A3: "Q3"
  - A4: "Q4"
  - B1: 1250
  - B2: 1450
  - B3: 1680
  - B4: 1920

visualizations:
  quarterly_sales:
    type: bar
    title: "Quarterly Sales"
    labels: A1:A4
    data: B1:B4
```

Features

• ✅ Full Moss syntax support
• ✅ Formulas and functions
• ✅ Bar chart visualizations
• ✅ Custom themes and display modes
• ✅ Error handling with helpful messages
• ✅ TypeScript support

Related

• Moss - Main Moss project
• remark-moss - Remark plugin for Moss
• markdown-it - Markdown parser

License

MIT