Overview
Nellie is a powerful Visual Studio Code extension designed to assist in HTML validation, entity checking, art file verification, and more. It's an all-in-one tool for ensuring your HTML files meet specific standards and requirements.
Features
1. HTML Validation
- Validates markup
- Checks heading hierarchy
- Verifies unused scripts
2. Entity Checker
- Identifies non-basic ASCII characters within 'p' tags
- Prompts for conversion to Unicode entities
3. Art Checker
- Verifies art file specifications (size, dimensions)
- Supports local directory and full workspace scans
4. Cross Checker (Work in Progress)
- Compares manuscript files with HTML code
- Checks for correct text conversion, formatting, and punctuation
5. LO Initializer (Experimental)
- Converts DOCX manuscripts to HTML structure
6. Workspace Settings
- Automatically updates workspace settings to Nelson specifications
Data Collection
This extension collects anonymous usage data using AWS CloudWatch to help us improve the user experience. We do not collect any personal information. The collected data includes:
- Commands used
- Errors encountered
For more information about our data collection practices, please visit our Privacy Policy.
Installation
- Open Visual Studio Code
- Go to Extensions (Ctrl+Shift+X)
- Search for "Nellie"
- Click Install
Usage
- Open an HTML file in VS Code
- Use the command palette (
Ctrl+Shift+P) and type nellie
- Choose from the following commands:
nellie.checkAll: Initiates all checks: Validation, Heading Hierarchy, Scripts, Entities, Art Specs, and Cross Checknellie.checkHTML: Validates HTML, checks heading hierarchy, identifies unused scripts, and offers to generate missing scripts and style tagsnellie.checkEntities: Highlights non-basic ASCII characters and prompts for Unicode conversionnellie.checkArt: Verifies art specs, flagging images wider than 1,710 px and media over 20 MBnellie.generateAltText: Prompts for grade level, scans media, sends base64 to OpenAI, and inserts generated alt text (Proof of Concept)nellie.crossCheck: Compares manuscript file with HTML code (Experimental)nellie.initLO: Generates initial HTML structure by analyzing the manuscript document (Experimental)
Configuration
Nellie automatically updates workspace settings to Nelson specifications. No additional configuration is required.
Requirements
- Visual Studio Code version 1.53.0 or higher
Known Issues
- None at this time. Please reach out to support@destinade.com with any issues.
Contributing
Please reach out to support@destinade.com for more information.
License
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.
Support
For support, please open an issue on the GitHub repository or contact support@destinade.com.
Changelog
See CHANGELOG.md for a detailed list of changes in each version.
Authors
Happy coding with Nellie!
