-
Notifications
You must be signed in to change notification settings - Fork 376
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
docs: bump Docsy to v0.8.0, enable search, enhance highlighting, simplify theme customizations and more fixes #1829
Merged
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
Notably to enable search in the documentation. This breaks compatibility with the custom changes as they upgraded from bootstrap 4 to boostrap 5. Signed-off-by: Mahe Tardy <[email protected]>
As Docsy was updated, they moved from Bootstrap 4 to 5 and many of those custom CSS was not working, this commit removes everything and start fresh from the default theme. Some customizations will be picked up again and adjusted in the next commits. Signed-off-by: Mahe Tardy <[email protected]>
Signed-off-by: Mahe Tardy <[email protected]>
Using shell-session was a bad idea as it is only relevant when placing command prompt as $ or #. Shell is more appropriate for color syntax. Signed-off-by: Mahe Tardy <[email protected]>
Algolia provide free research for open-source documentation website. Signed-off-by: Mahe Tardy <[email protected]>
mtardy
added
area/documentation
Improvements or additions to documentation
release-note/docs
This PR updates the documentation.
labels
Dec 1, 2023
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mtardy
force-pushed
the
pr/mtardy/doc-fix-docsy
branch
2 times, most recently
from
December 1, 2023 20:59
6e897e9
to
442a15b
Compare
willfindlay
approved these changes
Dec 1, 2023
mtardy
force-pushed
the
pr/mtardy/doc-fix-docsy
branch
3 times, most recently
from
December 1, 2023 23:41
ca75f7d
to
7a0fed9
Compare
A big portion is retrieved from the Pixelpoint work, but some of it is new, the goal is to be lightweight and to not modify the theme too much. This add many custom fixes to the Docsy theme. It was a bit painful to do but now I'm a bit familiar with how those things works and hopefully everything looks more balanced now. Signed-off-by: Mahe Tardy <[email protected]>
The icon frontmatter is messing up with the CSS for some reasons. Signed-off-by: Mahe Tardy <[email protected]>
Signed-off-by: Mahe Tardy <[email protected]>
mtardy
force-pushed
the
pr/mtardy/doc-fix-docsy
branch
from
December 4, 2023 10:40
7a0fed9
to
39e899d
Compare
Signed-off-by: Mahe Tardy <[email protected]>
mtardy
force-pushed
the
pr/mtardy/doc-fix-docsy
branch
from
December 4, 2023 12:13
39e899d
to
90de443
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area/documentation
Improvements or additions to documentation
release-note/docs
This PR updates the documentation.
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.
See preview.
This will fix almost all issues in the web development list in the issue #1023.
Closes #1023.