Convert ASM MD-Staff HTML documentation into organized Markdown files with proper structure, images, and JSON formatting. Creates categorized docs for Query Endpoints and Triggered Webhooks.
This skill helps Claude Code work with the ASM MD-Staff documentation repository, which contains Python tools for converting HTML documentation into organized Markdown files.
Process ASM (MD-Staff) HTML documentation and create structured documentation for:
**Key Dependencies:**
**Output Structure:** Creates organized directories under `asm_docs/` with categorized markdown files
#### Query Documentation (`asm_docs/query/`)
1. `01_overview` - Basic Query Endpoint concepts and security
2. `02_options` - Fields, filters, sorting, counts, pagination
3. `03_provider_records` - Core provider data types and examples
4. `04_enrollment` - Provider enrollments, entities, networks
5. `05_additional` - Supplementary provider information
6. `06_security` - Security models and permissions
7. `07_other_records` - Lookups, reference sources, history
#### Triggered Webhooks Documentation (`asm_docs/triggered_webhooks/`)
1. `01_setup` - API keys, webhook endpoints, triggered messages
2. `02_operations` - Testing, logging, troubleshooting
3. `03_examples` - Sample configurations and payloads
1. **Check for required dependencies:**
```bash
pip list | grep -E "beautifulsoup4|html2text"
```
2. **Install missing dependencies:**
```bash
pip install beautifulsoup4 html2text
```
**Convert Query Endpoint documentation:**
```bash
python3 html_to_markdown_converter.py "Query Endpoint – ASM.html"
```
**Convert Triggered Webhooks documentation:**
```bash
python3 html_to_markdown_converter.py "Triggered Webhooks – ASM.html"
```
The script auto-detects document type and creates the appropriate structure.
**Image Processing:**
**JSON Detection and Formatting:**
**Content Organization:**
**Sub-Records Support:**
**Security and Permissions:**
1. **Verify file structure** before running conversion - ensure HTML files and asset directories are present
2. **Check output directories** (`asm_docs/query/` or `asm_docs/triggered_webhooks/`) to verify proper structure creation
3. **Review generated markdown** for proper image links and JSON formatting
4. **Validate JSON blocks** if making changes to the converter's JSON detection logic
5. **Test with both documentation types** (Query Endpoints and Triggered Webhooks) when modifying the converter
**Add a new documentation section:**
1. Update the section mapping in `html_to_markdown_converter.py`
2. Add corresponding directory structure under `asm_docs/`
3. Update README.md files to include new section
**Fix image paths:**
1. Check the HTML asset directory name matches expected pattern
2. Verify images are being copied to the `images/` folder
3. Confirm relative paths are correct in generated markdown
**Improve JSON detection:**
1. Review the JSON validation logic in the converter
2. Test with edge cases (nested JSON, escaped characters)
3. Ensure code fences are properly applied
Leave a review
No reviews yet. Be the first to review this skill!
# Download SKILL.md from killerskills.ai/api/skills/asm-md-staff-html-to-markdown-converter/raw