Skip to content

Commit 7ef9d65

Browse files
sharevbsharevb
committed
Merge branch 'feat/markdown-cheatsheet' into chore/all-my-stuffs
# Conflicts: # src/tools/index.ts
2 parents 9cd3841 + 894f259 commit 7ef9d65

File tree

5 files changed

+207
-1
lines changed

5 files changed

+207
-1
lines changed

‎pnpm-lock.yaml

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/tools/index.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ import { tool as daysCalculator } from './days-calculator';
6464
import { tool as dateDurationCalculator } from './date-duration-calculator';
6565
import { tool as macAddressConverter } from './mac-address-converter';
6666
import { tool as dockerComposeToKubernetesConverter } from './docker-compose-to-kubernetes';
67+
import { tool as asciiTextDrawer } from './ascii-text-drawer';
6768
import { tool as textToUnicode } from './text-to-unicode';
6869
import { tool as certificateKeyParser } from './certificate-key-parser';
6970
import { tool as crcCalculator } from './crc-calculator';
@@ -120,6 +121,7 @@ import { tool as imageToAsciiArt } from './image-to-ascii-art';
120121
import { tool as ipv6SubnetCalculator } from './ipv6-subnet-calculator';
121122
import { tool as jsonEscaper } from './json-escaper';
122123
import { tool as jsonLinter } from './json-linter';
124+
import { tool as markdownCheatsheet } from './markdown-cheatsheet';
123125
import { tool as pdfSignatureChecker } from './pdf-signature-checker';
124126
import { tool as numeronymGenerator } from './numeronym-generator';
125127
import { tool as macAddressGenerator } from './mac-address-generator';
@@ -338,6 +340,7 @@ export const toolsByCategory: ToolCategory[] = [
338340
torrentToMagnet,
339341
unicodeSearch,
340342
jsonEscaper,
343+
asciiTextDrawer,
341344
],
342345
},
343346
{
@@ -366,6 +369,7 @@ export const toolsByCategory: ToolCategory[] = [
366369
name: 'Development',
367370
components: [
368371
gitMemo,
372+
markdownCheatsheet,
369373
randomPortGenerator,
370374
crontabGenerator,
371375
jsonViewer,
@@ -435,6 +439,7 @@ export const toolsByCategory: ToolCategory[] = [
435439
ipCidrToRange,
436440
ipv4RangeExpander,
437441
ipRangeToCidr,
442+
ipv4RangeExpander,
438443
macAddressLookup,
439444
macAddressGenerator,
440445
ipv6UlaGenerator,
@@ -454,6 +459,7 @@ export const toolsByCategory: ToolCategory[] = [
454459
percentageCalculator,
455460
angleConverter,
456461
],
462+
percentageCalculator],
457463
},
458464
{
459465
name: 'Measurement',
@@ -479,6 +485,7 @@ export const toolsByCategory: ToolCategory[] = [
479485
benchmarkBuilder,
480486
benchmarkBuilder,
481487
energyComputer,
488+
benchmarkBuilder,
482489
],
483490
},
484491
{

‎src/tools/markdown-cheatsheet/index.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { Markdown } from '@vicons/tabler';
2+
import { defineTool } from '../tool';
3+
4+
export const tool = defineTool({
5+
name: 'Markdown Cheat Sheet',
6+
path: '/markdown-cheatsheet',
7+
description: 'Markdown Cheat Sheet',
8+
keywords: ['markdown', 'cheatsheet', 'memo'],
9+
component: () => import('./markdown-cheatsheet.vue'),
10+
icon: Markdown,
11+
createdAt: new Date('2024-03-09'),
12+
});

‎src/tools/markdown-cheatsheet/markdown-cheatsheet.vue

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<script setup lang="ts">
2+
import { useThemeVars } from 'naive-ui';
3+
import Memo from './md-memo.content.md';
4+
5+
const themeVars = useThemeVars();
6+
</script>
7+
8+
<template>
9+
<div>
10+
<Memo />
11+
</div>
12+
</template>
13+
14+
<style lang="less" scoped>
15+
::v-deep(pre) {
16+
margin: 0;
17+
padding: 15px 22px;
18+
background-color: v-bind('themeVars.cardColor');
19+
border-radius: 4px;
20+
overflow: auto;
21+
}
22+
</style>

‎src/tools/markdown-cheatsheet/md-memo.content.md

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
layout: default
3+
title: Markdown Cheat Sheet
4+
description: A quick reference to the Markdown syntax.
5+
last_modified_at: 2021-12-05
6+
---
7+
8+
## Overview
9+
10+
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can't cover every edge case, so if you need more information about any of these elements, refer to the reference guides for <n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/">basic-syntax</n-a> and <n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/">extended-syntax</n-a>.
11+
12+
## Basic Syntax
13+
14+
These are the elements outlined in John Gruber's original design document. All Markdown applications support these elements.
15+
16+
<n-table :single-line="false">
17+
<thead>
18+
<tr>
19+
<th>Element</th>
20+
<th>Markdown Syntax</th>
21+
</tr>
22+
</thead>
23+
<tbody>
24+
<tr>
25+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#headings">Heading</n-a></td>
26+
<td><code># H1<br>
27+
## H2<br>
28+
### H3</code></td>
29+
</tr>
30+
<tr>
31+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#bold">Bold</n-a></td>
32+
<td><code>**bold text**</code></td>
33+
</tr>
34+
<tr>
35+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#italic">Italic</n-a></td>
36+
<td><code>*italicized text*</code></td>
37+
</tr>
38+
<tr>
39+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#blockquotes-1">Blockquote</n-a></td>
40+
<td><code>> blockquote</code></td>
41+
</tr>
42+
<tr>
43+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#ordered-lists">Ordered List</n-a></td>
44+
<td><code>
45+
1. First item<br>
46+
2. Second item<br>
47+
3. Third item<br>
48+
</code></td>
49+
</tr>
50+
<tr>
51+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#unordered-lists">Unordered List</n-a></td>
52+
<td>
53+
<code>
54+
- First item<br>
55+
- Second item<br>
56+
- Third item<br>
57+
</code>
58+
</td>
59+
</tr>
60+
<tr>
61+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#code">Code</n-a></td>
62+
<td><code>`code`</code></td>
63+
</tr>
64+
<tr>
65+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#horizontal-rules">Horizontal Rule</n-a></td>
66+
<td><code>---</code></td>
67+
</tr>
68+
<tr>
69+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#links">Link</n-a></td>
70+
<td><code>[title](https://www.example.com)</code></td>
71+
</tr>
72+
<tr>
73+
<td><n-a target="_blank" href="https://www.markdownguide.org/basic-syntax/#images-1">Image</n-a></td>
74+
<td><code>![alt text](image.jpg)</code></td>
75+
</tr>
76+
</tbody>
77+
</n-table>
78+
79+
## Extended Syntax
80+
81+
These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
82+
83+
<n-table :single-line="false">
84+
<thead>
85+
<tr>
86+
<th>Element</th>
87+
<th>Markdown Syntax</th>
88+
</tr>
89+
</thead>
90+
<tbody>
91+
<tr>
92+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#tables">Table</n-a></td>
93+
<td><code>
94+
| Syntax | Description |<br>
95+
| ----------- | ----------- |<br>
96+
| Header | Title |<br>
97+
| Paragraph | Text |
98+
</code></td>
99+
</tr>
100+
<tr>
101+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#fenced-code-blocks">Fenced Code Block</n-a></td>
102+
<td><code>```<br>
103+
{<br>
104+
&nbsp;&nbsp;"firstName": "John",<br>
105+
&nbsp;&nbsp;"lastName": "Smith",<br>
106+
&nbsp;&nbsp;"age": 25<br>
107+
}<br>
108+
```
109+
</code></td>
110+
</tr>
111+
<tr>
112+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#footnotes">Footnote</n-a></td>
113+
<td><code>
114+
Here's a sentence with a footnote. [^1]<br><br>
115+
[^1]: This is the footnote.
116+
</code></td>
117+
</tr>
118+
<tr>
119+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#heading-ids">Heading ID</n-a></td>
120+
<td><code>### My Great Heading {#custom-id}</code></td>
121+
</tr>
122+
<tr>
123+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#definition-lists">Definition List</n-a></td>
124+
<td><code>
125+
term<br>
126+
: definition
127+
</code></td>
128+
</tr>
129+
<tr>
130+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#strikethrough">Strikethrough</n-a></td>
131+
<td><code>~~The world is flat.~~</code></td>
132+
</tr>
133+
<tr>
134+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#task-lists">Task List</n-a></td>
135+
<td><code>
136+
- [x] Write the press release<br>
137+
- [ ] Update the website<br>
138+
- [ ] Contact the media
139+
</code></td>
140+
</tr>
141+
<tr>
142+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#emoji">Emoji</n-a><br>(see also <n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji">Copying and Pasting Emoji</n-a>)</td>
143+
<td><code>
144+
That is so funny! :joy:
145+
</code></td>
146+
</tr>
147+
<tr>
148+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#highlight">Highlight</n-a></td>
149+
<td><code>
150+
I need to highlight these ==very important words==.
151+
</code></td>
152+
</tr>
153+
<tr>
154+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#subscript">Subscript</n-a></td>
155+
<td><code>
156+
H~2~O
157+
</code></td>
158+
</tr>
159+
<tr>
160+
<td><n-a target="_blank" href="https://www.markdownguide.org/extended-syntax/#superscript">Superscript</n-a></td>
161+
<td><code>
162+
X^2^
163+
</code></td>
164+
</tr>
165+
</tbody>
166+
</n-table>

0 commit comments

Comments
 (0)