Add small readme

This commit is contained in:
Darks 2021-02-10 22:27:34 +01:00
parent 5e52622b26
commit d622e4e3fb
Signed by: Darks
GPG Key ID: 7515644268BE1433
1 changed files with 21 additions and 1 deletions

View File

@ -1,3 +1,23 @@
# md2bbc
Markdown to PC's BBcode. Quick n' dirty one.
Markdown to PC's BBcode. Quick'n'dirty one.
## Usage
```
python3 md2bbc.py input.md > output.bbcode
```
## Features
- `# H1 title`
- `## H2 title`
- `### H3 title`
- `*emphasis text*`
- `**strong text**`
- `[link](https://domain.tld)`
- `{{ tableofcontents }}`
More features may be added in the future, but this script is provided as it.
Only (very) simple markup will produce correct output.
Always check BBcode validity before posting.