documentation - Syntax for documenting JSON structure - Stack Overflow
Looking for a PyQt5 example to put a Json file into a treeview model item
Example of working JSON file for Dreambooth extension
JSON starts with { and ends with } and it shouldn't have a space before or after. You cannot include comments like you can with js.
Never leave a comma at the end, always use double quotes " not single ' and make sure it follows something like...
{ "objectProp1": "object content", "objectProp2": "object content with no comma because it's the last prop in the object" }
You can also have nested properties but the general rules above typically apply. This is from memory so might be a bit wonky but if this fails to help, use a online Json checker to see if your Json is valid.
If you have funky emojis and stuff maybe you will need to "escape" them, Google html encoding or Json character escaping to get the friendly versions of unicode characters
More on reddit.comXMRig JSON Config File Guide
Videos
Factsheet
In theory JSON Schema could serve this purpose, but in practice I am not sure it does. Worth mentioning I hope.
Other than this, my personal opinion is that since JSON is predominantly used for transferring objects, documenting equivalent objects in language client uses (Java, C#, various scripting languages) may make most sense -- after all, such objects usually are mapped/bound to JSON and back. And then you can use whatever documentation tools are available, like Javadoc for Java (perldoc for Perl, Oxygen for c++ etc etc).
For specifying interfaces there is also WADL (Web App Description Language), which might help.
How to generate a HTML Documentation from JSON:
You will need to generate a Json Schema, there is this service that you can paste the orginal JSON and auto generate the Schema:
http://www.jsonschema.net/
With the schema in hands you can auto generate the HTML Documentation using Matic.
https://github.com/mattyod/matic
Generating HTML
To Install Matic you will need install Node.js: http://nodejs.org/
On Windows, run CMD
Install Jade running this command:
npm install -g jade
Open the Downloaded Matic folder from Github:
cd PATH_TO_FOLDER/matic
Run the install command:
npm install -g
Download a documentation example project: https://github.com/mattyod/matic-simple-example
Put your schema in the folder "schemas"
Open the project folder:
cd PATH_TO_PROJECT_FOLDER
Run command:
matic
You should see a success message:
Documentation built to ./web/