[Add Feature] View docs in a more comfortable way #2478
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 Report
@@ Coverage Diff @@
## devel #2478 +/- ##
==========================================
+ Coverage 91.54% 91.55% +0.01%
==========================================
Files 183 183
Lines 7561 7561
==========================================
+ Hits 6921 6922 +1
+ Misses 640 639 -1 |
|
I think you may want to update the e.g. |
|
updated that |
|
Nice, don't forget to remove the files currently committed in those locations. |
|
deleted node_modules and docs/.vitepress/dist |
adehad
suggested changes
Sep 7, 2022
Co-authored-by: Adel Haddad <[email protected]>
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.
Description
When I'm reading the documentation, I felt a bit uncomfortable when traveling between files.
So I think I can change that by using a static website generator. In this case, I pick vitepress, which is a framework that specifies with writing documentation on various Github Projects.
You can see the final work on :
https://ryankert01.github.io/Catch2/
I think it is pretty nice with the look and the experience and can potentially attract more users.