-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
[#12271] Docs: Upgrade to latest MarkBind version #12893
Conversation
Thanks for working on this @jingting1412 ! Would you revise the issue description so it is easier for teammates people to review? I think screenshots/video will help :) Comparing the new appearance against the old, I think that the sticky header and working PUML are actually already in the live dev docs - so the only "change" in the UI is the breadcrumbs (as auto-breadcrumbs being a MarkBind feature added in 5.0). Is that correct? (if it is, maybe can separate out the UI change from your explanations of why the other code changed 😅 I understand that the |
thanks @kaixin-hc for the suggestion! I've done more testing on my deployed branch and have since updated the description to better reflect the nature of the changes and to add images. Regarding the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for providing a deployed version of the docs for us to look at!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the change! It is good to keep the variable file in case we need to declare some in the future.
package.json
Outdated
@@ -75,6 +75,7 @@ | |||
"eslint-plugin-rxjs": "^5.0.3", | |||
"jest": "^29.7.0", | |||
"lintspaces-cli": "^0.7.1", | |||
"markbind-cli": "^5.3.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't be needed. Only the package.json
file in docs/
folder needs the change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jingting1412 I believe you have figured it out, but the main project (thus root package.json
) has nothing to do with MarkBind. This is not a Lerna monorepo project whereby the root package.json
affects the one in the docs folder.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes understood thank you, I have since reverted the changes I've made to the main json files.
This reverts commit 76b2d44.
Fixes #12271
Outline of Solution
Upgraded the docs to the latest version of Markbind, v5.3.0 (full release notes can be found here).
I have deployed it from my branch at this link
UI changes:
Other changes:
sticky
so that it remains at the top of the page while scrolling. From testing on my deployed branch, using<header fixed>
would sometimes not cause the header to remain at the top while scrolling, shown in the screenshot below which is at this location on the page:As the screenshot shows, the header is not present when I've scrolled down the page. As such I've changed it to
<header sticky>
to ensure that it would always stick to the top while scrollingstyle.puml
is included in the puml diagrams. From testing on my own deployed branch, the include statement!include diagrams/style.puml
would sometimes cause the path to be resolved wrongly as shown in this commit. When I changed the statement to just!include style.puml
, the diagrams are correctly shown as seen in this commit