markdown2png / schema.md
broadfield-dev's picture
Update schema.md
9a1bdee verified

Supported Format Schemas


1. Repo2Markdown Format

Detection: Contains `## File Structure` AND `### File:`. Purpose: Representing project codebases. Layout Example:

# Project Export
## File Structure
- main.py
- utils.py

### File: main.py
```python
print("Hello World")
\```

2. Standard README Format

Detection: Starts with `#` and contains at least one `##`. Purpose: Parsing typical project documentation. Layout Example:

# Project Title
Intro text here.

## Installation
Step 1...

## Usage
Run the app...

3. Changelog Format

Detection: Version headings like `## [1.0.0]`. Purpose: Version tracking and release notes. Layout Example:

# Changelog
## [1.1.0] - 2023-10-01
- Added feature X.

## [1.0.0] - 2023-09-01
- Initial release.

4. Agent Action Format

Detection: Contains `### HF_ACTION:` or "File and Code Formatting:". Purpose: Automating Hugging Face Space setup. Layout Example:

**File and Code Formatting:**
General instructions for the agent go here.

### HF_ACTION: INSTALL requirements.txt

### File: app.py
```python
import flask
# code here
\```

## File Structure
\```
.
└── app.py
\```

5. Recipe/Guide Format (Logical Addition)

Detection: Contains `## Ingredients` and `## Instructions`. Purpose: Parsing structured "How-To" guides. Layout Example:

# Chocolate Cake
## Ingredients
- 2 cups Flour
- 1 cup Cocoa

## Instructions
1. Mix dry ingredients...
2. Bake at 180°C...