Browse Source

Add small readme

master
Darks 8 months ago
parent
commit
d622e4e3fb
Signed by: Darks GPG Key ID: 7515644268BE1433
  1. 22
      README.md

22
README.md

@ -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.
Loading…
Cancel
Save