Export Offline documentation improvements
under review
Nivedha Mohan
- The project logo in the top-left doesn't appear in multilingual projects.
- The project logo click event (overlay link) isn't applied.
- Language dropdown in the top-right: country flag images are missing.
- The article title and the top-level heading in the article body are both rendered as H2 in HTML export.
- The footer section isn't displayed in the exported file.
- The right-side panel (tags, table of contents) is not included.
- Attachment download links currently use absolute paths, which prevents files from opening when the documentation is accessed locally, even if the files are present. It would be helpful if the system could support relative paths for attachment download links so that files can be accessed correctly in local or offline environments.
Log In
D
D360 Product Management
Merged in a post:
Offline documentation improvements
F
Famous Newt
The latest update provides an option to export to offline documentation, which is highly appreciated. I have the following feedback and suggestions, though:
a) The exported offline documentation does NOT use the site CSS (at least I do not see any option to influence that). Since our article content heavily relies on custom styles, the output looks pretty dull.
b) It were great if you could specify the categories to include in the offline documentation more easily. Currently, you need to specify each single category individually. This gets tedious and error-prone if you only need to export a subset, and have to select multiple categories. An option to select a category and include all sub-category would be highly appreciated. Especially, if you want to automate it using API, you need to provide an endless list of GUIDs.
c) Related to b). I'd like to have some kind of check/warning if you select a couple of categories, and have some articles that link to other articles which are not included in the exported content. In that case you will end up with broken links!
Thanks!
D
D360 Product Management
updated the status to
under review
K
Kavya
Hi Golden poppy Quail ,Nivedha Mohan,
Thank you for consolidating these observations—this is helpful.
We understand that these issues are primarily related to HTML/offline export behavior and feature parity with the live KB site, including:
Missing project logo and click behavior in multilingual setups
Language dropdown flag assets not appearing
Heading structure inconsistency (title vs body heading as H2)
Footer not included in export
Right-side panel (ToC, tags) not present
Attachment links using absolute paths, causing issues in offline/local environments
We’ll take this as a set of improvement requests and evaluate them collectively as part of enhancing offline documentation consistency and completeness.
In particular, items like:
Relative path support for attachments
UI parity (header, footer, RHS components)
Structural consistency (headings, navigation elements)
will require careful evaluation due to their impact on export architecture and compatibility.
This will be reviewed based on priority, implementation scope, and customer traction, and we’ll share updates as we make progress.
Nivedha Mohan
Raised on behalf of Golden poppy Quail
Karthikeyan J
+ Dual Wildcat
W
Whole Kite
hi Famous Newt,
Thank you for the request. It is very detailed and gives us clarity on the expectation. Please find the responses below,
a. Yes, the exported document has its own CSS. When the offline documentation is downloaded, we also expose the CSS along with the same. This is to ensure that we give this control to the user to modify it accordingly. To develop this feature, we would take significant effort, instead you can update the CSS in the downloaded document, and use the same CSS for the other downloads as well.
b. We understand this usability issue, we will address this and update you in this thread.
c. This is a pretty advanced feature but the pain point is very much real. We will prioritize this based on the Customer requests.
d. We don't currently support export using offline documentation in APIs. We understand this is something you want. When we prioritize this, we will also consider the request to allow multiple calls at the same time.
//Antonyraj Sebastin Historic Heron
F
Famous Newt
Amendment to b) It seems that the API (/v2/Project/Export) by default retrieves JSON output. Is there a way to export HTML offline doucmentation?
Amendment d) Only one export at a time is allowed, which is rather limiting. What is worse is that if you initiate an export, while another export is already in progress (but with different parameters, e.g. a different set of selected categories), the API seems to return the ID of the first export. IMHO, it should return a dedicated result that another export is already in progress.