zhanshi/goldmark
1
0
Fork 0
mirror of https://github.com/yuin/goldmark synced 2025-03-04 23:04:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Link to CommonMark website in README.md

Browse source 
Link to the CommonMark website to explicitly reference what it is, and to help users unfamiliar with it to discover and navigate to it.

CommonMark is mentioned very early in the README. Here it is a subheadline. I decided to not link here but in this features section instead where it is listed as one of the features. The subheadline seems more fitting as a short, pure text for those knowing about it.

The link is to the main website rather than the specification as users unfamiliar with it will want to land on the landing page with a description of what it is rather than a technical specification. The specification page does not immediately and obviously link back to the main website.

The shortened term spec is being extended to its full word specification for clarity and discoverability.
This commit is contained in:
Jan Klass 2019-12-31 10:14:18 +01:00
parent f9b134f6be
commit 471456b80a
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -38,7 +38,7 @@ As mentioned above, CommonMark is too complicated and hard to implement, so Mark
Features
----------------------
- **Standard compliant.** goldmark gets full compliance with the latest CommonMark spec.
- **Standard compliant.** goldmark gets full compliance with the latest [CommonMark](https://commonmark.org/) specification.
- **Extensible.** Do you want to add a `@username` mention syntax to Markdown?
You can easily do it in goldmark. You can add your AST nodes,
parsers for block level elements, parsers for inline level elements,