Add Docusaurus for documentation #6705
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #6705 +/- ##
=========================================
Coverage 64.87% 64.87%
Complexity 1934 1934
=========================================
Files 317 317
Lines 15959 15959
Branches 2280 2280
=========================================
Hits 10353 10353
Misses 4630 4630
Partials 976 976
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
|
For the record, I also like VuePress-generated sites like https://www.nushell.sh/. |
As another (late) note to myself, also https://squidfunk.github.io/mkdocs-material/ seems to be widely used (Clikt, Ktorfit). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds Docusaurus for generating a website out of ORT's documentation. The draft PR is for discussion purposes to allow the maintainers to decide whether to create such a site.
The PR adds a GitHub Actions workflow for building the site, for which the demo is currently hosted here: https://doubleopen-project.github.io/ort/.
The site includes a full-text search, for which the index is built during the workflow, so no external service is currently needed.
The contents are currently just the documentation markdown files copied as-is, due to why a lot of the internal links are broken. Should this be deployed at some point, they need to be fixed.