add: bozodown doc
This commit is contained in:
20
doc/bozodown/block.md
Normal file
20
doc/bozodown/block.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Block
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
-----
|
||||
style
|
||||
---
|
||||
content
|
||||
-----
|
||||
```
|
||||
|
||||
| name | usage |
|
||||
| --- | --- |
|
||||
| style | Your custom css, multiline supported |
|
||||
| content | Your bozodown |
|
||||
|
||||
## Effect
|
||||
|
||||
Create a div with custom css
|
13
doc/bozodown/checkbox.md
Normal file
13
doc/bozodown/checkbox.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Checkbox
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
- [ ] your text
|
||||
or
|
||||
- [x] your text
|
||||
```
|
||||
|
||||
## Effect
|
||||
|
||||

|
BIN
doc/bozodown/checkbox.png
Normal file
BIN
doc/bozodown/checkbox.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 3.9 KiB |
17
doc/bozodown/code.md
Normal file
17
doc/bozodown/code.md
Normal file
@ -0,0 +1,17 @@
|
||||
# Quote
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
\```
|
||||
your text
|
||||
\```
|
||||
```
|
||||
|
||||
## Effect
|
||||
your text
|
||||
|
||||
to
|
||||
```
|
||||
your text
|
||||
```
|
11
doc/bozodown/image.md
Normal file
11
doc/bozodown/image.md
Normal file
@ -0,0 +1,11 @@
|
||||
# Image
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
![url]
|
||||
```
|
||||
|
||||
## Effect
|
||||
|
||||
display the image
|
10
doc/bozodown/quote.md
Normal file
10
doc/bozodown/quote.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Quote
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
`your text`
|
||||
```
|
||||
|
||||
## Effect
|
||||
your text -> `your text`
|
19
doc/bozodown/readme.md
Normal file
19
doc/bozodown/readme.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Bozodown
|
||||
|
||||
A markdown like, written in python, modulable
|
||||
|
||||
## Feature
|
||||
|
||||
### Text Formater
|
||||
- [title](./title.md)
|
||||
- [subtitle](./subtitle.md)
|
||||
- [subsubtitle](./subsubtitle.md)
|
||||
- [subsubsubtitle](./subsubsubtitle.md)
|
||||
- [code](./code.md)
|
||||
- [image](./image.md)
|
||||
- [block](./block.md)
|
||||
- [checkbox](./checkbox.md)
|
||||
|
||||
### Text Modifier
|
||||
- [strong](./strong.md)
|
||||
- [quote](./quote.md)
|
11
doc/bozodown/strong.md
Normal file
11
doc/bozodown/strong.md
Normal file
@ -0,0 +1,11 @@
|
||||
# Strong
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
**your text**
|
||||
```
|
||||
|
||||
## Effect
|
||||
|
||||
your text -> **your text**
|
13
doc/bozodown/subsubsubtitle.md
Normal file
13
doc/bozodown/subsubsubtitle.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Subsubsubtitle
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
#### your text
|
||||
```
|
||||
|
||||
## Effect
|
||||
your text
|
||||
|
||||
to
|
||||
#### your text
|
13
doc/bozodown/subsubtitle.md
Normal file
13
doc/bozodown/subsubtitle.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Subsubtitle
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
### your text
|
||||
```
|
||||
|
||||
## Effect
|
||||
your text
|
||||
|
||||
to
|
||||
### your text
|
13
doc/bozodown/subtitle.md
Normal file
13
doc/bozodown/subtitle.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Subtitle
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
## your text
|
||||
```
|
||||
|
||||
## Effect
|
||||
your text
|
||||
|
||||
to
|
||||
## your text
|
13
doc/bozodown/title.md
Normal file
13
doc/bozodown/title.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Title
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
# your text
|
||||
```
|
||||
|
||||
## Effect
|
||||
your text
|
||||
|
||||
to
|
||||
# your text
|
Reference in New Issue
Block a user