You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
749 B
Markdown
45 lines
749 B
Markdown
# Snekdown - A wonderful markdown parser
|
|
|
|
This projects goal is to implement a fast markdown parser with an extended syntax fitted
|
|
for my needs.
|
|
|
|
## Syntax
|
|
|
|
### Images
|
|
|
|
```
|
|
Simple Syntax
|
|
!(url)
|
|
|
|
Extended syntax with a description
|
|
|
|
|
|
Extended syntax with metadata to specify the size
|
|
[metadata]
|
|
|
|
Extended syntax with metadata and no description
|
|
!(url)[metadata]
|
|
```
|
|
|
|
### Quotes
|
|
|
|
```
|
|
Simple (default) Syntax
|
|
> This is a quote
|
|
|
|
Multiline
|
|
> This is a
|
|
> Multiline Quote
|
|
|
|
Quote with metadata (e.g. Author)
|
|
[Trivernis - 2020]> This is a quote with metadata
|
|
```
|
|
|
|
### Imports
|
|
|
|
Imports can be used to import a different document to be attached to the main document.
|
|
Imports are parsed via multithreading.
|
|
|
|
```
|
|
<[path]
|
|
``` |