[libraries/md4qt] docs: Update the documentation
Igor Mironchik <[email protected]>
| Newsgroups | gmane.comp.kde.cvs |
|---|---|
| Message-ID | <[email protected]> |
Git commit 0d20ebf3535fb2cb72e17803fa440a8ad61b55d0 by Igor Mironchik.
Committed on 07/08/2026 at 04:35.
Pushed by imironchik into branch 'master'.
Update the documentation
M +48 -40 docs/md4qt-README.qdocinc
https://invent.kde.org/libraries/md4qt/-/commit/0d20ebf3535fb2cb72e17803fa440a8ad61b55d0
diff --git a/docs/md4qt-README.qdocinc b/docs/md4qt-README.qdocinc
index 5604c3c..c164768 100644
--- a/docs/md4qt-README.qdocinc
+++ b/docs/md4qt-README.qdocinc
@@ -7,24 +7,24 @@ This library parses Markdown into tree structure.
\list
- \li \l {#Example//home/igor/Work/Archive/repos/md4qt/README.md} {Example}
- \li \l {#License//home/igor/Work/Archive/repos/md4qt/README.md} {License}
- \li \l {#Benchmark//home/igor/Work/Archive/repos/md4qt/README.md} {Benchmark}
- \li \l {#Playground//home/igor/Work/Archive/repos/md4qt/README.md} {Playground}
- \li \l {#Release-notes//home/igor/Work/Archive/repos/md4qt/README.md} {Release notes}
- \li \l {#What-should-I-know-about-links-in-the-document//home/igor/Work/Archive/repos/md4qt/README.md} {What should I know about links in the document?}
- \li \l {#What-is-the-second-argument-of-MDParserparse//home/igor/Work/Archive/repos/md4qt/README.md} {What is the second argument of \c {MD::Parser::parse()}?}
- \li \l {#What-is-an-MDAnchor//home/igor/Work/Archive/repos/md4qt/README.md} {What is an \c {MD::Anchor}?}
- \li \l {#Does-the-library-throw-exceptions//home/igor/Work/Archive/repos/md4qt/README.md} {Does the library throw exceptions?}
- \li \l {#How-can-I-convert-MDDocument-into-HTML//home/igor/Work/Archive/repos/md4qt/README.md} {How can I convert \c {MD::Document} into \c {HTML}?}
- \li \l {#How-can-I-obtain-positions-of-blockselements-in-Markdown-file//home/igor/Work/Archive/repos/md4qt/README.md} {How can I obtain positions of blocks/elements in \c {Markdown} file?}
- \li \l {#How-can-I-easily-traverse-through-the-MDDocument//home/igor/Work/Archive/repos/md4qt/README.md} {How can I easily traverse through the \c {MD::Document}?}
- \li \l {#Is-it-possible-to-find-Markdown-item-by-its-position//home/igor/Work/Archive/repos/md4qt/README.md} {Is it possible to find \c {Markdown} item by its position?}
- \li \l {#How-can-I-walk-through-the-document-and-find-all-items-of-given-type//home/igor/Work/Archive/repos/md4qt/README.md} {How can I walk through the document and find all items of given type?}
- \li \l {#How-can-I-add-and-process-a-custom-user-defined-item-in-MDDocument//home/igor/Work/Archive/repos/md4qt/README.md} {How can I add and process a custom (user-defined) item in \c {MD::Document}?}
+ \li \l {#Example//home/igor/Work/Projects/md4qt/README.md} {Example}
+ \li \l {#License//home/igor/Work/Projects/md4qt/README.md} {License}
+ \li \l {#Benchmark//home/igor/Work/Projects/md4qt/README.md} {Benchmark}
+ \li \l {#Playground//home/igor/Work/Projects/md4qt/README.md} {Playground}
+ \li \l {#Release-notes//home/igor/Work/Projects/md4qt/README.md} {Release notes}
+ \li \l {#What-should-I-know-about-links-in-the-document//home/igor/Work/Projects/md4qt/README.md} {What should I know about links in the document?}
+ \li \l {#What-is-the-second-argument-of-MDParserparse//home/igor/Work/Projects/md4qt/README.md} {What is the second argument of \c {MD::Parser::parse()}?}
+ \li \l {#What-is-an-MDAnchor//home/igor/Work/Projects/md4qt/README.md} {What is an \c {MD::Anchor}?}
+ \li \l {#Does-the-library-throw-exceptions//home/igor/Work/Projects/md4qt/README.md} {Does the library throw exceptions?}
+ \li \l {#How-can-I-convert-MDDocument-into-HTML//home/igor/Work/Projects/md4qt/README.md} {How can I convert \c {MD::Document} into \c {HTML}?}
+ \li \l {#How-can-I-obtain-positions-of-blockselements-in-Markdown-file//home/igor/Work/Projects/md4qt/README.md} {How can I obtain positions of blocks/elements in \c {Markdown} file?}
+ \li \l {#How-can-I-easily-traverse-through-the-MDDocument//home/igor/Work/Projects/md4qt/README.md} {How can I easily traverse through the \c {MD::Document}?}
+ \li \l {#Is-it-possible-to-find-Markdown-item-by-its-position//home/igor/Work/Projects/md4qt/README.md} {Is it possible to find \c {Markdown} item by its position?}
+ \li \l {#How-can-I-walk-through-the-document-and-find-all-items-of-given-type//home/igor/Work/Projects/md4qt/README.md} {How can I walk through the document and find all items of given type?}
+ \li \l {#How-can-I-add-and-process-a-custom-user-defined-item-in-MDDocument//home/igor/Work/Projects/md4qt/README.md} {How can I add and process a custom (user-defined) item in \c {MD::Document}?}
\endlist
-\target #Example//home/igor/Work/Archive/repos/md4qt/README.md
+\target #Example//home/igor/Work/Projects/md4qt/README.md
\section1 Example
\code /
@@ -55,7 +55,7 @@ int main()
}
\endcode
-\target #License//home/igor/Work/Archive/repos/md4qt/README.md
+\target #License//home/igor/Work/Projects/md4qt/README.md
\section1 License
\code /
@@ -65,14 +65,9 @@ int main()
*\1
\endcode
-\target #Benchmark//home/igor/Work/Archive/repos/md4qt/README.md
+\target #Benchmark//home/igor/Work/Projects/md4qt/README.md
\section1 Benchmark
-Approximate benchmark with \l {https://github.com/github/cmark-gfm} {cmark-gfm} says,
-that Qt6 version of \c {md4qt} is slower ~8 times.
-But you will get complete C++ tree structure of the Markdown document with all
-major extensions and sugar and cherry on the cake.
-
\table
@@ -80,7 +75,7 @@ major extensions and sugar and cherry on the cake.
\li Markdown library
- \li Result
+ \li Result \e{(approximate time of parsing \c {tests/manual/complex.md} document)}
\row
@@ -90,26 +85,39 @@ major extensions and sugar and cherry on the cake.
\row
- \li \c {md4qt} with \c {Qt6}
+ \li \c {md4qt}
\li ~1.7 ms
\row
- \li \c {md4qt} with \c {Qt6} without \c {GitHub} auto-links extension
+ \li \c {md4qt} without \c {GitHub} auto-links extension
\li ~1.2 ms
\endtable
-\target #Playground//home/igor/Work/Archive/repos/md4qt/README.md
+\target #Playground//home/igor/Work/Projects/md4qt/README.md
\section1 Playground
-You can play in action with \c {md4qt} in \l {https://github.com/igormironchik/markdown-tools} {Markdown Tools}. There you can find \c {Markdown} editor/viewer/converter to \c {PDF}.
-And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} uses \c {md4qt} too.
+\table
+
+ \header
+
+ \li Applications using \c {md4qt}
+
+ \row
+
+ \li \l {https://github.com/igormironchik/markdown-tools} {Markdown Tools}
+
+ \row
+
+ \li \l {https://invent.kde.org/office/klevernotes} {KleverNotes}
+
+\endtable
-\target #Release-notes//home/igor/Work/Archive/repos/md4qt/README.md
+\target #Release-notes//home/igor/Work/Projects/md4qt/README.md
\section1 Release notes
@@ -122,7 +130,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
Markdown, so keep it in mind.
\endlist
-\target #What-should-I-know-about-links-in-the-document//home/igor/Work/Archive/repos/md4qt/README.md
+\target #What-should-I-know-about-links-in-the-document//home/igor/Work/Projects/md4qt/README.md
\section1 What should I know about links in the document?
@@ -147,7 +155,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
\endlist
-\target #What-is-the-second-argument-of-MDParserparse//home/igor/Work/Archive/repos/md4qt/README.md
+\target #What-is-the-second-argument-of-MDParserparse//home/igor/Work/Projects/md4qt/README.md
\section1 What is the second argument of \c {MD::Parser::parse()}?
@@ -158,7 +166,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
then they will be parsed too and will exist in the resulting document.
\endlist
-\target #What-is-an-MDAnchor//home/igor/Work/Archive/repos/md4qt/README.md
+\target #What-is-an-MDAnchor//home/igor/Work/Projects/md4qt/README.md
\section1 What is an \c {MD::Anchor}?
@@ -169,7 +177,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
the document you reached new file.
\endlist
-\target #Does-the-library-throw-exceptions//home/igor/Work/Archive/repos/md4qt/README.md
+\target #Does-the-library-throw-exceptions//home/igor/Work/Projects/md4qt/README.md
\section1 Does the library throw exceptions?
@@ -180,7 +188,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
example.
\endlist
-\target #How-can-I-convert-MDDocument-into-HTML//home/igor/Work/Archive/repos/md4qt/README.md
+\target #How-can-I-convert-MDDocument-into-HTML//home/igor/Work/Projects/md4qt/README.md
\section1 How can I convert \c {MD::Document} into \c {HTML}?
@@ -207,7 +215,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
\endlist
-\target #How-can-I-obtain-positions-of-blockselements-in-Markdown-file//home/igor/Work/Archive/repos/md4qt/README.md
+\target #How-can-I-obtain-positions-of-blockselements-in-Markdown-file//home/igor/Work/Projects/md4qt/README.md
\section1 How can I obtain positions of blocks/elements in \c {Markdown} file?
@@ -218,7 +226,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
of any element will point to the last symbol in this element.
\endlist
-\target #How-can-I-easily-traverse-through-the-MDDocument//home/igor/Work/Archive/repos/md4qt/README.md
+\target #How-can-I-easily-traverse-through-the-MDDocument//home/igor/Work/Projects/md4qt/README.md
\section1 How can I easily traverse through the \c {MD::Document}?
@@ -239,7 +247,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
\endlist
-\target #Is-it-possible-to-find-Markdown-item-by-its-position//home/igor/Work/Archive/repos/md4qt/README.md
+\target #Is-it-possible-to-find-Markdown-item-by-its-position//home/igor/Work/Projects/md4qt/README.md
\section1 Is it possible to find \c {Markdown} item by its position?
@@ -249,7 +257,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
nested first children by given position with \c {MD::PosCache::findFirstInCache()} method.
\endlist
-\target #How-can-I-walk-through-the-document-and-find-all-items-of-given-type//home/igor/Work/Archive/repos/md4qt/README.md
+\target #How-can-I-walk-through-the-document-and-find-all-items-of-given-type//home/igor/Work/Projects/md4qt/README.md
\section1 How can I walk through the document and find all items of given type?
@@ -280,7 +288,7 @@ And \l {https://invent.kde.org/office/klevernotes} {KleverNotes} from \c {KDE} u
\endlist
-\target #How-can-I-add-and-process-a-custom-user-defined-item-in-MDDocument//home/igor/Work/Archive/repos/md4qt/README.md
+\target #How-can-I-add-and-process-a-custom-user-defined-item-in-MDDocument//home/igor/Work/Projects/md4qt/README.md
\section1 How can I add and process a custom (user-defined) item in \c {MD::Document}?