Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Output in JSON instead of HTML/Markdown #3551

Open
testersen opened this issue Mar 28, 2024 · 1 comment
Open

Output in JSON instead of HTML/Markdown #3551

testersen opened this issue Mar 28, 2024 · 1 comment
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@testersen
Copy link

Question
Is it possible to export all documentation as a JSON file instead of HTML or Markdown?

I have a use case where I have a multi-module project that I want to generate documentation for. In this multi-module project I need to have both API documentation (provided by Dokka), but also regular documentation hand-written in markdown. These should go together in a custom generator that generates more json files indexed by pagefind, and then finally, uploaded to a blob store where our documentation site will see the version, then download and cache it for offline-use. The HTML content is a website that comes separate from the documentation.

Keeping the documentation site and the documentation data separate allows us to maintain the website for both API references and guides on all versions without having to rebuild the documentation sources.

@testersen testersen added the question A user question, can be resolved if the question is answered/resolved label Mar 28, 2024
@whyoleg
Copy link
Contributor

whyoleg commented Mar 28, 2024

Not at this moment, please take a look at: #621 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question A user question, can be resolved if the question is answered/resolved
Projects
None yet
Development

No branches or pull requests

2 participants