Skip to content

Commit 1279864

Browse files
authored
test README.md
1 parent 4454844 commit 1279864

File tree

1 file changed

+161
-0
lines changed

1 file changed

+161
-0
lines changed

README.md

+161
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,163 @@
11
# cool-markdown
22
Vanilla Markdown Tricks For Much Better README Files
3+
4+
5+
# Tricks
6+
7+
## permanent link to a code snippet
8+
[**How To Get a Link**](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet)
9+
https://github.com/stevemar/code-reference-in-readme/blob/031e04f922c14ecd5b03a79d8c979ba8f3ab1e39/src/main.py#L1-L6
10+
11+
## Alerts
12+
> [!NOTE]
13+
> Useful information that users should know, even when skimming content.
14+
15+
> [!TIP]
16+
> Helpful advice for doing things better or more easily.
17+
18+
> [!IMPORTANT]
19+
> Key information users need to know to achieve their goal.
20+
21+
> [!WARNING]
22+
> Urgent info that needs immediate user attention to avoid problems.
23+
24+
> [!CAUTION]
25+
> Advises about risks or negative outcomes of certain actions.
26+
## Todo Special
27+
- [x] #1
28+
- [ ] https://github.com/eymeen/cool-markdown/issues/1
29+
- [ ] https://github.com/eymeen/cool-markdown/pulls/1
30+
- [ ] Add delight to the experience when all tasks are complete
31+
32+
## Yaml, [jekyll](https://github.com/jekyll/jekyll-gist)
33+
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.
34+
## posting gists
35+
```
36+
{% gist __NUMBER__ __FILENAME__ %}
37+
```
38+
`{% gist 5555251 gist.md %}`
39+
40+
## Diagrams
41+
you can create [here](https://mermaid.live/edit) and paste it in the MD file
42+
43+
### Simple
44+
```mermaid
45+
graph TD;
46+
Create_this-->Get_Sponsored;
47+
Create_this-->Get_10_stars;
48+
Create_this-->get_100_forks;
49+
get_100_forks-->D;
50+
Get_10_stars-->D;
51+
Get_Sponsored-->D;
52+
```
53+
###
54+
```mermaid
55+
xychart-beta
56+
title "Sales Revenue"
57+
x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
58+
y-axis "Revenue (in $)" 4000 --> 11000
59+
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
60+
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
61+
```
62+
### geojson Maps
63+
```geojson
64+
{
65+
"type": "FeatureCollection",
66+
"features": [
67+
{
68+
"type": "Feature",
69+
"id": 1,
70+
"properties": {
71+
"ID": 0
72+
},
73+
"geometry": {
74+
"type": "Polygon",
75+
"coordinates": [
76+
[
77+
[-90,35],
78+
[-90,30],
79+
[-85,30],
80+
[-85,35],
81+
[-90,35]
82+
]
83+
]
84+
}
85+
}
86+
]
87+
}
88+
```
89+
### topojson Maps
90+
```topojson
91+
{
92+
"type": "Topology",
93+
"transform": {
94+
"scale": [0.0005000500050005, 0.00010001000100010001],
95+
"translate": [100, 0]
96+
},
97+
"objects": {
98+
"example": {
99+
"type": "GeometryCollection",
100+
"geometries": [
101+
{
102+
"type": "Point",
103+
"properties": {"prop0": "value0"},
104+
"coordinates": [4000, 5000]
105+
},
106+
{
107+
"type": "LineString",
108+
"properties": {"prop0": "value0", "prop1": 0},
109+
"arcs": [0]
110+
},
111+
{
112+
"type": "Polygon",
113+
"properties": {"prop0": "value0",
114+
"prop1": {"this": "that"}
115+
},
116+
"arcs": [[1]]
117+
}
118+
]
119+
}
120+
},
121+
"arcs": [[[4000, 0], [1999, 9999], [2000, -9999], [2000, 9999]],[[0, 0], [0, 9999], [2000, 0], [0, -9999], [-2000, 0]]]
122+
}
123+
```
124+
## 3D Models
125+
```stl
126+
solid cube_corner
127+
facet normal 0.0 -1.0 0.0
128+
outer loop
129+
vertex 0.0 0.0 0.0
130+
vertex 1.0 0.0 0.0
131+
vertex 0.0 0.0 1.0
132+
endloop
133+
endfacet
134+
facet normal 0.0 0.0 -1.0
135+
outer loop
136+
vertex 0.0 0.0 0.0
137+
vertex 0.0 1.0 0.0
138+
vertex 1.0 0.0 0.0
139+
endloop
140+
endfacet
141+
facet normal -1.0 0.0 0.0
142+
outer loop
143+
vertex 0.0 0.0 0.0
144+
vertex 0.0 0.0 1.0
145+
vertex 0.0 1.0 0.0
146+
endloop
147+
endfacet
148+
facet normal 0.577 0.577 0.577
149+
outer loop
150+
vertex 1.0 0.0 0.0
151+
vertex 0.0 1.0 0.0
152+
vertex 0.0 0.0 1.0
153+
endloop
154+
endfacet
155+
endsolid
156+
```
157+
158+
## Math
159+
$`\sqrt{3x-1}+(1+x)^2`$ $`Or`$ $`Just`$ $`This`$ $`Cool`$ $`Font`$
160+
161+
## Math Blocks
162+
**The Cauchy-Schwarz Inequality**
163+
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

0 commit comments

Comments
 (0)