Use YAML examples in documentation by default, not JSON
See original GitHub issueYAML configuration is much better for multi-line strings, and I’m increasingly adding configuration options to Datasette that benefit from that - fragments of HTML in description_html
or SQL queries used to configure things like https://github.com/simonw/datasette-atom for example.
Rather than confusing things by showing both in the documentation, I should switch all of the default examples to use YAML instead.
Issue Analytics
- State:
- Created 3 years ago
- Comments:10 (10 by maintainers)
Top Results From Across the Web
YAML Tutorial: Everything You Need to Get Started in Minutes
Here's a YAML tutorial to get you started quickly. ... Before we take a deeper dive, let's look at how this document looks...
Read more >Is there a way to generate API Documentation in YAML (not ...
I would like to generate the API documentation in YAML format, not JSON. By default, springfox generates JSON. I have looked into using...
Read more >10 YAML tips for people who hate YAML | Enable Sysadmin
This works best for small data sets. Just write your JSON data into a Python variable, prepend an import statement, and end the...
Read more >YAML Tutorial | User Manual - Taurus
YAML format allows multiple documents to be embedded in a single file. They only have to be separated with a line containing triple-dash...
Read more >YAML Syntax - Ansible Documentation
We use YAML because it is easier for humans to read and write than other common data formats like XML or JSON. Further,...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Beginnings of a UI element for switching between them:
That
<pre>
has a padding of 12px, so using 12px padding on the tab links should get them to line up better.Undocumented Sphinx feature: you can add extra classes to a code example like this:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block doesn’t mention this.
Filed an issue about the lack of documentation here: