https://github.com/squarescreamyt/sqmd
sq's custom version of MarkDown! (WIP)
https://github.com/squarescreamyt/sqmd
Last synced: 3 months ago
JSON representation
sq's custom version of MarkDown! (WIP)
- Host: GitHub
- URL: https://github.com/squarescreamyt/sqmd
- Owner: SquareScreamYT
- License: mit
- Created: 2024-10-28T07:26:15.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-05T04:56:06.000Z (8 months ago)
- Last Synced: 2025-01-30T05:27:02.599Z (5 months ago)
- Language: CSS
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sq's Markdown
## Introduction
This is a guide to using sqmd, a Markdown-like language that is a superset of Markdown with extended features. This document is best viewed in VS Code with [this extension pack](https://marketplace.visualstudio.com/items?itemName=bierner.github-markdown-preview).
## Headings
Headings in sqmd are the same as in Markdown:
```
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
```
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
## Text Formatting
Text formatting in sqmd is the same as in Markdown:
```
*Italic*
**Bold**
~~Strikethrough~~
_Underline_
```
*Italic*
**Bold**
~~Strikethrough~~
Underline
---
To highlight text, use surround your text with 2 equal signs:
```
==Highlighted Text==
```
Highlighted Text
---
To make it so that your sentence doesn't create a new line, use a \ at the end of the line.
```
This is the first line.\
This is the second line.
```
This is the first line.
This is the second line.
## Horizontal Lines
To make a horizontal line, use three dashes:
---
## Code Blocks
To create a code block, use three backticks:
`````
```
Code Block
```
`Code Block` within a sentence
````
```
Code Block inside a code block
```
````
`````
```
Code Block
```
`Code Block` within a sentence
````
```
Code Block inside a code block
```
````
## Block Quotes
To create a block quote, use a greater than symbol:
```
> Block Quote
> > More Block Quote
```
> Block Quote
> > More Block Quote
## Lists
To create a list, use dashes or numbers:
```
- Item
- Item
- Item
- Item
- Item
1. Item 1
2. Item 2
a. Item 2a
b. Item 2b
3. Item 3
```
- Item
- Item
- Item
- Item
- Item
1. Item 1
2. Item 2
a. Item 2a
b. Item 2b
3. Item 3
## Links
To create a link, use square brackets for the text and parentheses for the link:
```
[Link](https://example.com)
```
[Link](https://example.com)
## Images
To create an image, use an exclamation point, square brackets for the alt text, and parentheses for the link, and curly brackets for the size:
```
{200,100}
```
## Tables
To create a table, use pipes to separate columns and dashes to separate rows:
```
| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Row 1 | Row 1 | Row 1 |
| Row 2 | Row 2 | Row 2 |
| Row 3 | Row 3 | Row 3 |
```
| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Row 1 | Row 1 | Row 1 |
| Row 2 | Row 2 | Row 2 |
| Row 3 | Row 3 | Row 3 |
You can also use colons to align the columns:
```
| Left Aligned | Center Aligned | Right Aligned |
| :----------- | :------------: | ------------: |
| Left | Center | Right |
```
| Left Aligned | Center Aligned | Right Aligned |
| :----------- | :------------: | ------------: |
| Left | Center | Right |
You can add to the column and row span by using `\k` for row span and `\l` for column span:
```
| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Row 1 | Row 1 \l |
| Row 2 | Row 2 | Row 2 \k |
| Row 3 | Row 3 | |
```
Column 1
Column 2
Column 3
Row 1
Row 1
Row 2
Row 2
Row 2
Row 3
Row 3
Remember to leave a blank where the extra cell would be.
## Task List
To create a task list, use a dash followed by a space and a bracket:
```
- [ ] Task
- [x] Completed Task
```
- [ ] Task
- [x] Completed Task
## Subscripts and Superscripts
To create a subscript, use a tilde followed by the text:
```
H~2~O
```
H2O
To create a superscript, use a caret followed by a text:
```
x^2^
```
x2
## Definition List
To create a definition list, use a colon followed by a space and the definition:
```
Term 1
: Definition 1
Term 2
: Definition 2
```
- Term 1
- Definition 1
- Term 2
- Definition 2
## Emoji
To create an emoji, use a colon followed by the name of the emoji:
```
:smile:
:apple:
:books:
```
:smile:
:apple:
:books:
## Colors
To set a text to a color, use `\c` followed by a hexcode, and then `\e`:
```
\c#ff6347\eThis red is really nice
```
This red is really nice
To set the highlight color, use `\h` followed by a hexcode, and then `\e`:
```
\h#ff6347\eIt looks like the color of a tomato
```
It looks like the color of a tomato
To reset the color, use `\r`:
```
\c#ff6347\eRed\r White
```
Red White
## Abbreviations
To create an abbreviation, use an asterisk followed by square brackets surrounding the abbreviation, and then a colon followed by the full name:
```
*[MD]: MarkDown
```
MD
## Comments
Comments in sqmd are the same as in Javascript:
```
// This is a single line comment
/*
This is a
multi-line
comment
*/
```
Comments are not displayed in the output.
## Default Colors
To add default colors, use `/* */` at the start of the file:
```
/*
background-color:#0d1117,
text-color:#dadfda,
highlight-color:#272115,
code-color:#151b23,
link-color:#0000ee
*/
```
This will change the default colors to of the output.
## Footnotes
To create a footnote, use a caret followed by a number:
```
Here is a footnote[^1]
[^1]: This is the footnote
```
Here is a footnote[^1]
[^1]: This is the footnote