Vanilla Markdown Tricks For Much Better README Files, everything you need
- vanilla MD
- with jekyll
- cool non-vanilla MD but using fancy recourses, not the typical crap.
- profile/project README examples
- simple online editor as github page
- Future: tiny details README (such as social link decoration, ability to change font)
- add valuable resources list that has readme thingies to add (like shields and other real-time data viewing UIs)
- Make a file that has README rules to make the file attractive and informative
https://github.com/USERNAME/REPOSITORY/blob/COMMIT_HASH/FILENAME?plain=1#LX-LX
LX - LX == line range, written like this (exmp) : L3-L11
Lines 11 to 22 in 1279864
Note
Useful information that users should know, even when skimming content.
Tip
Helpful advice for doing things better or more easily.
Important
Key information users need to know to achieve their goal.
Warning
Urgent info that needs immediate user attention to avoid problems.
Caution
Advises about risks or negative outcomes of certain actions.
- #1
- https://github.com/eymeen/cool-markdown/issues/1
- https://github.com/eymeen/cool-markdown/pulls/1
- Add delight to the experience when all tasks are complete
Yaml, jekyll
Although this is not considered 100% vanilla, but it's something you can do in github, and it will enable you to make better stuff in the MD.
{% gist __NUMBER__ __FILENAME__ %}
{% gist 5555251 gist.md %}
you can create here and paste it in the MD file
graph TD;
Create_this-->Get_Sponsored;
Create_this-->Get_10_stars;
Create_this-->get_100_forks;
get_100_forks-->D;
Get_10_stars-->D;
Get_Sponsored-->D;
xychart-beta
title "Sales Revenue"
x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"id": 1,
"properties": {
"ID": 0
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[37.85, 36.2],
[37.85, 36.15],
[37.9, 36.15],
[37.95, 36.18],
[37.9, 36.2],
[37.85, 36.2]
]
]
}
}
]
}
{
"type": "Topology",
"transform": {
"scale": [0.0005000500050005, 0.00010001000100010001],
"translate": [100, 0]
},
"objects": {
"example": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Point",
"properties": {"prop0": "value0"},
"coordinates": [4000, 5000]
},
{
"type": "LineString",
"properties": {"prop0": "value0", "prop1": 0},
"arcs": [0]
},
{
"type": "Polygon",
"properties": {"prop0": "value0",
"prop1": {"this": "that"}
},
"arcs": [[1]]
}
]
}
},
"arcs": [[[4000, 0], [1999, 9999], [2000, -9999], [2000, 9999]],[[0, 0], [0, 9999], [2000, 0], [0, -9999], [-2000, 0]]]
}
solid cube_corner
facet normal 0.0 -1.0 0.0
outer loop
vertex 0.0 0.0 0.0
vertex 1.0 0.0 0.0
vertex 0.0 0.0 1.0
endloop
endfacet
facet normal 0.0 0.0 -1.0
outer loop
vertex 0.0 0.0 0.0
vertex 0.0 1.0 0.0
vertex 1.0 0.0 0.0
endloop
endfacet
facet normal -1.0 0.0 0.0
outer loop
vertex 0.0 0.0 0.0
vertex 0.0 0.0 1.0
vertex 0.0 1.0 0.0
endloop
endfacet
facet normal 0.577 0.577 0.577
outer loop
vertex 1.0 0.0 0.0
vertex 0.0 1.0 0.0
vertex 0.0 0.0 1.0
endloop
endfacet
endsolid
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent