What Is README to JSON Conversion?
README files often contain structured data hidden within Markdown formatting. This tool extracts JSON data from README documents in two ways: it looks for JSON code blocks (```json) and parses them, or it analyzes Markdown structure with bold field names and types to reconstruct a JSON object. This is useful for migrating documentation to structured data formats.
How to Convert README to JSON
- Paste your README Markdown containing either a JSON code block or structured bullet points with bold field names and parenthesized types.
- Click Convert to JSON to extract the data. The tool prioritizes JSON code blocks but falls back to Markdown parsing.
- Copy the JSON for use in configuration files, data processing, or as a structured backup of your documentation.
Frequently Asked Questions
How does the Markdown parsing work?
The tool looks for lines matching **fieldname** (*type*) patterns. The type determines the default value: number becomes 0, boolean becomes true, array becomes [], and strings become "value".
What if both a code block and Markdown structure are present?
The JSON code block takes priority. If one is found, it is parsed directly. Otherwise, the tool falls back to analyzing the Markdown bullet structure.
Can I generate a README from JSON?
Yes, use the Swap button to create a structured README document from your JSON data.