[Documentation] Examples should be in plain markup
See original GitHub issueProblem to solve
the code examples for things like what classes to use are very hard to understand because they’ve all been made with script.
eg
v-for="a in align"
:key="a"
:class="`d-flex align-${a} mb-6`"
i cannot read that at a glance to see the valid syntax in the simplest case.
Proposed solution
Just list them plainly as examples, in longhand, so the reader can quickly refer to the actual expected syntax.
Issue Analytics
- State:
- Created 3 years ago
- Reactions:8
- Comments:19 (11 by maintainers)
Top Results From Across the Web
Introductory Guide to Markdown for Documentation Writers
It allows you to style a digital text document using typical formatting techniques: for example, headings, emphasis, lists, images, and links.
Read more >Markup, Markdown: Write In Elegant Plain Text
Documents can only be viewed correctly with the software used to create ... Markdown is a syntax that uses plaintext to format documents....
Read more >Documenting Your Workloads With Markdown - RONIN BLOG
Markdown is a lightweight markup language that can be used to create formatted text from plain text using specific syntax.
Read more >Formatting your documentation content - Apple Developer
DocC includes a custom dialect of Markdown, documentation markup, which extends ... For the page title of an article or API collection, use...
Read more >Plain text documentation in version control - the 3 best markup ...
Plain text documentation in version control – the 3 best markup languages ... Writing technical project documentation using proprietary formats ...
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 Free
Top 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
Hi, mind I take this one?
okay, I can help with some pages, will start fixing them nad make PRs for each section.