YGGverse/gemini-php
1
0
Fork 0
mirror of https://github.com/YGGverse/gemini-php.git synced 2025-02-05 03:34:33 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ghost 2024-02-01 12:32:46 +02:00
parent 98c46adb21
commit 8bd95cf5c2
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -38,7 +38,11 @@ echo $reader->setRule(
#### Reader::toGemini
Convert DokuWiki to Gemini markup
Convert DokuWiki text to Gemini markup
As wiki has lot of inline links, to make converted document well-readable, this method does not replace links with new line `=>` macros, but uses inline context: `Name ( URL )`. This model useful with `Reader::getLinks` method that, that for example appends all related links to the document footer.
If you don't like this implementation, feel free to change it by `Reader::setRule` method.
```
echo $reader->toGemini(