diff --git a/doc/bozodown/block.md b/doc/bozodown/block.md new file mode 100644 index 0000000..8bef95c --- /dev/null +++ b/doc/bozodown/block.md @@ -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 \ No newline at end of file diff --git a/doc/bozodown/checkbox.md b/doc/bozodown/checkbox.md new file mode 100644 index 0000000..996e89e --- /dev/null +++ b/doc/bozodown/checkbox.md @@ -0,0 +1,13 @@ +# Checkbox + +## Usage + +``` +- [ ] your text +or +- [x] your text +``` + +## Effect + +![](./checkbox.png) \ No newline at end of file diff --git a/doc/bozodown/checkbox.png b/doc/bozodown/checkbox.png new file mode 100644 index 0000000..a7ef4c6 Binary files /dev/null and b/doc/bozodown/checkbox.png differ diff --git a/doc/bozodown/code.md b/doc/bozodown/code.md new file mode 100644 index 0000000..6e18c93 --- /dev/null +++ b/doc/bozodown/code.md @@ -0,0 +1,17 @@ +# Quote + +## Usage + +``` +\``` +your text +\``` +``` + +## Effect +your text + +to +``` +your text +``` \ No newline at end of file diff --git a/doc/bozodown/image.md b/doc/bozodown/image.md new file mode 100644 index 0000000..04563c9 --- /dev/null +++ b/doc/bozodown/image.md @@ -0,0 +1,11 @@ +# Image + +## Usage + +``` +![url] +``` + +## Effect + +display the image \ No newline at end of file diff --git a/doc/bozodown/quote.md b/doc/bozodown/quote.md new file mode 100644 index 0000000..50c9828 --- /dev/null +++ b/doc/bozodown/quote.md @@ -0,0 +1,10 @@ +# Quote + +## Usage + +``` +`your text` +``` + +## Effect +your text -> `your text` \ No newline at end of file diff --git a/doc/bozodown/readme.md b/doc/bozodown/readme.md new file mode 100644 index 0000000..0836c66 --- /dev/null +++ b/doc/bozodown/readme.md @@ -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) diff --git a/doc/bozodown/strong.md b/doc/bozodown/strong.md new file mode 100644 index 0000000..bf8ee89 --- /dev/null +++ b/doc/bozodown/strong.md @@ -0,0 +1,11 @@ +# Strong + +## Usage + +``` +**your text** +``` + +## Effect + +your text -> **your text** \ No newline at end of file diff --git a/doc/bozodown/subsubsubtitle.md b/doc/bozodown/subsubsubtitle.md new file mode 100644 index 0000000..866982a --- /dev/null +++ b/doc/bozodown/subsubsubtitle.md @@ -0,0 +1,13 @@ +# Subsubsubtitle + +## Usage + +``` +#### your text +``` + +## Effect +your text + +to +#### your text \ No newline at end of file diff --git a/doc/bozodown/subsubtitle.md b/doc/bozodown/subsubtitle.md new file mode 100644 index 0000000..16c967b --- /dev/null +++ b/doc/bozodown/subsubtitle.md @@ -0,0 +1,13 @@ +# Subsubtitle + +## Usage + +``` +### your text +``` + +## Effect +your text + +to +### your text \ No newline at end of file diff --git a/doc/bozodown/subtitle.md b/doc/bozodown/subtitle.md new file mode 100644 index 0000000..cf704e9 --- /dev/null +++ b/doc/bozodown/subtitle.md @@ -0,0 +1,13 @@ +# Subtitle + +## Usage + +``` +## your text +``` + +## Effect +your text + +to +## your text \ No newline at end of file diff --git a/doc/bozodown/title.md b/doc/bozodown/title.md new file mode 100644 index 0000000..2a55503 --- /dev/null +++ b/doc/bozodown/title.md @@ -0,0 +1,13 @@ +# Title + +## Usage + +``` +# your text +``` + +## Effect +your text + +to +# your text \ No newline at end of file