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.

[DOCS] Markdown formatting issue in `README.md`

See original GitHub issue

Description

There’s an issue that prevents proper Markdown formatting in the README.md file.

Steps to contribute

Fork the repository here.
Create a new branch in your fork named fix_markdown.
Open the README.md file.
In line 17, remove the space before the ** at the end. This will fix the bold text being formatted wrongly. To do it easier, replace the current content with the following content:

**Optional fields: `milestones`, `type(personal | community)`, `socials`, `testimonials` and `events`**\

Commit and push your changes.
Create a pull request.
You’re done now! 🎉 You just have to wait until the maintainers review your PR.

If you need any help, let us know! 😃

Screenshots

No response

Additional information

This is a good first issue. Please leave it open to first-time contributors and beginners. 🙂

Issue Analytics

State:
Created 9 months ago
Comments:7 (4 by maintainers)

Top GitHub Comments

1reaction

Sriparno08commented, Dec 25, 2022

Hey @Panquesito7, I would like to work on this issue!

0reactions

aravindraveendran7commented, Dec 27, 2022

Thank you @eddiejaoude

Top Results From Across the Web

Basic writing and formatting syntax - GitHub Docs

Create sophisticated formatting for your prose and code on GitHub with simple syntax.

GitLab Flavored Markdown (GLFM)

GitLab uses standard CommonMark formatting. However, GitLab Flavored Markdown extends standard Markdown with features made specifically for GitLab.

Basic Syntax - Markdown Guide

Nearly all Markdown applications support the basic syntax outlined in the original Markdown design document. There are minor variations and discrepancies ...

How to write in Markdown - The MDN Web Docs project

The baseline for MDN Markdown is GitHub-Flavored Markdown (GFM): ... However, the Markdown syntax is required as a matter of style.

Working with README.md on github.com - Stack Overflow

There are many Markdown dialects, the documentation for Github's can be found on the Github ... grip --gfm --context=username/repo issue.md.