question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[Documentation] Examples should be in plain markup

See original GitHub issue

Problem 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:closed
  • Created 3 years ago
  • Reactions:8
  • Comments:19 (11 by maintainers)

github_iconTop GitHub Comments

2reactions
AngeloBoninicommented, Jan 21, 2021

Hi, mind I take this one?

1reaction
KareemDacommented, Nov 3, 2021

I haven’t yet gotten around to it, been caught up with work. This has shifted in priorities for me, however, I’m still keen to tackle this. Might only get to it in a few weeks time.

okay, I can help with some pages, will start fixing them nad make PRs for each section.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found