Documentation revamp update
Nicolas Fella
nicolas.fella at gmx.de
Fri May 16 16:09:10 BST 2025
Hi,
in your qdocconf file you can add a "navigation.landingpage = Foo" where
Foo is the title of the page.
See https://invent.kde.org/libraries/md4qt/-/merge_requests/18
Cheers
Nico
Am 10.05.25 um 12:42 schrieb Igor Mironchik:
> I have a question.
>
> Consider I have index page like:
>
> /*!
> \module md4qt
> \title md4qt C++ Classes
> \ingroup modules
> \cmakepackage md4qt
> \cmakecomponent md4qt
>
> \brief Header-only C++ library for parsing Markdown.
>
> \include md4qt-README.qdocinc
> */
>
> In included .qdocinc I have a link to:
>
> /*!
> \page md4qt-known_issues.md.html
> \title Known issues
> \inmodule md4qt
>
> \brief Known issues
>
> \include md4qt-known_issues.qdocinc
> */
>
> Great. All works. Only one thing - when I navigate from index page to
> any class from it I see in navigation bar a link to this index
> (module) page, that is very useful. But when I navigate from my index
> page to my second page (Known issues) I don't see in navigation bar a
> link to module, index page. This upsets me.
>
> So my question is how can I add a level to navigation bar on my second
> page to module, index page?
>
> Thank you.
>
> On 04.04.2025 15:47, Nicolas Fella wrote:
>> Hi,
>>
>> I'm happy to announce a major milestone in our effort to improve our API
>> documentation website by porting it to QDoc.
>>
>> We now have a preview of the new site available at
>> https://api-staging.kde.org/, with all Frameworks converted to the new
>> syntax.
>>
>> Please have a look and report any issues. We do have some flexibility
>> regarding content and appearance, but please understand that we have to
>> work within what QDoc provides, so we might not be able to accommodate
>> all requests easily.
>>
>> One major thing that's currently missing is a search function. There's
>> some thoughts and a WIP at
>> https://invent.kde.org/teams/documentation/sprints/-/issues/81. Help
>> with this and other web-development topics is welcome.
>>
>> Currently the documentation syntax changes for the frameworks are in a
>> separate branch, we will merge these to master as we are going live with
>> the new site.
>>
>> The current plan is to go live with Frameworks only once the site is
>> ready, other libraries can be converted/added over time.
>>
>> You can find some instructions about converting in
>> https://invent.kde.org/-/snippets/3206
>>
>> Thanks to everyone who contributed to this effort!
>>
>> Cheers
>>
>> Nico
>>
>>
More information about the kde-devel
mailing list