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

Add support to populate pre-exisiting markdowns files (documentation) #4023

Open
iamutkarshtiwari opened this issue Feb 7, 2025 · 0 comments
Labels
enhancement An issue for a feature or an overall improvement

Comments

@iamutkarshtiwari
Copy link

Is your feature request related to a problem? Please describe

Our project has several markdown documentations that were (and are being) manually added for developers to reference. These markdowns more elaborate than the regular API docs generated by Dokka and act as a supplementary information. The goal is to make Dokka able to populate these markdowns as well so that they can be rendered alongside on the same GitHub Pages as the API Docs autogenerated by Dokka.

Expectation

The Index on the left hand side should be segregable between API Docs auto-generated by Dokka and a custom section to host these markdowns.

Describe alternatives you've considered
For now, we'll be resorting to using mkdocs/mkdocs: Project documentation with Markdown. to rendering these markdown files.

@iamutkarshtiwari iamutkarshtiwari added the enhancement An issue for a feature or an overall improvement label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Development

No branches or pull requests

1 participant