From 7d739ed7773d6c54fa12b88581d88832899bf0e2 Mon Sep 17 00:00:00 2001 From: Starnakin Date: Wed, 9 Jul 2025 02:39:32 +0200 Subject: [PATCH] add: doc photodown --- doc/photodown/gallery.md | 53 ++++++++++++++++++++++++++++++++++++++++ doc/photodown/image.md | 16 ++++++++++++ doc/photodown/readme.md | 11 +++++++++ doc/readme.md | 6 +++++ 4 files changed, 86 insertions(+) create mode 100644 doc/photodown/gallery.md create mode 100644 doc/photodown/image.md create mode 100644 doc/photodown/readme.md create mode 100644 doc/readme.md diff --git a/doc/photodown/gallery.md b/doc/photodown/gallery.md new file mode 100644 index 0000000..c0cd16a --- /dev/null +++ b/doc/photodown/gallery.md @@ -0,0 +1,53 @@ +# Block + +## Usage + +``` ++++++ +config +--- +style +--- +content ++++++ +``` + +### Config + +| type | +| --- | +| image-list | + +| direction | +| --- | +| down | +| up | +| left | +| right | + + + +### Style +Just css + + +### Content + +``` +![img1] +description 1 +-- +![img2] +description 2 +-- +... +``` + +| name | usage | +| --- | --- | +| style | Your custom css, multiline supported | +| content | Your bozodown | + +## Effect + +Create a group of image \ No newline at end of file diff --git a/doc/photodown/image.md b/doc/photodown/image.md new file mode 100644 index 0000000..8d831cb --- /dev/null +++ b/doc/photodown/image.md @@ -0,0 +1,16 @@ +# Image + +Permit you to use your own image without think about small, thumb, large, reference the bulk page. Always permit you to use external image with the url + +## Usage + +``` +![./bulk/path_to_image/image_large_name_without_ext] +``` + +## Example +On my server I got this image `bulk/01613/01613.png`, so I will used put +``` +![./bulk/01613/01613] +``` +And the python will display an image clickable who link to the bulk page \ No newline at end of file diff --git a/doc/photodown/readme.md b/doc/photodown/readme.md new file mode 100644 index 0000000..d7a5317 --- /dev/null +++ b/doc/photodown/readme.md @@ -0,0 +1,11 @@ +# PhotoDown + +Just a simple extension of [BozoDown](../bozodown/readme.md) + +## Add + +- [Pictures gallery]() + +## Modify + +- [image](./image.md) diff --git a/doc/readme.md b/doc/readme.md new file mode 100644 index 0000000..588e4ff --- /dev/null +++ b/doc/readme.md @@ -0,0 +1,6 @@ +# PhotoHUB + +## Tools + +### Generate page +To let user create his own page this project use [BozoDown](./bozodown/readme.md) with the [PhotoDown](./photodown/readme.md) extension \ No newline at end of file