wbzyl/quartoedit-extension

QuartoEdit - Advanced Quarto Notebook Editor

A comprehensive Positron IDE extension for editing and validating Quarto notebooks with scientific journal compliance checking.

Features

🔍 Advanced Validation

• Markdown validation for scientific writing best practices
• LaTeX equation checking for syntax and formatting
• R code analysis with statistical best practice recommendations
• Real-time diagnostics as you type

📚 Journal Compliance

Support for major scientific journals:

• Nature - Title limits, abstract constraints, reference formatting
• IEEE - Abstract structure, equation numbering, reference style
• Science - Word limits, single-paragraph abstracts, terminology

🚀 Positron Integration

• Native R code execution and validation
• Streaming output support for long-running analysis
• Statistical code quality checks
• Reproducibility recommendations

Commands

• QuartoEdit: Validate Document - Complete document validation
• QuartoEdit: Check Journal Compliance - Check against specific journal requirements
• QuartoEdit: Validate R Code Chunks - Focus on R code quality

Installation

1. Install Positron IDE
2. Clone this repository
3. Run npm install to install dependencies
4. Run npm run compile to build the extension
5. Install the extension in Positron

Usage

1. Open a .qmd file in Positron
2. The extension automatically provides real-time validation
3. Use the Command Palette (Cmd+Shift+P) to access QuartoEdit commands
4. View diagnostics in the Problems panel

Validation Categories

Scientific Writing

• Passive voice detection
• First-person usage warnings
• Contraction identification
• Citation format checking
• Cross-reference validation

LaTeX Mathematics

• Balanced delimiter checking
• Syntax error detection
• Scientific notation recommendations
• Equation formatting guidelines

R Code Quality

• Syntax validation
• Style guide compliance
• Statistical best practices
• Reproducibility checks
• Package loading recommendations

Journal Compliance

• Nature: 90-char titles, 200-word abstracts, numbered references
• IEEE: Abstract structure, keyword requirements, equation numbering
• Science: 125-word abstracts, 4500-word limits, reference counts

Development

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Watch for changes
npm run watch

Requirements

• Positron IDE 2025.6.0 or later
• Node.js 18 or greater
• TypeScript support

Contributing

1. Fork the repository
2. Create your feature branch
3. Make your changes
4. Test with sample Quarto documents
5. Submit a pull request

License

MIT License - see LICENSE file for details

Acknowledgments

Built for the scientific community using Positron IDE's powerful data science capabilities.