-
Notifications
You must be signed in to change notification settings - Fork 1.6k
📖 Improve collapsible code sections and formatting of tutorials #5175
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
base: master
Are you sure you want to change the base?
📖 Improve collapsible code sections and formatting of tutorials #5175
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
b0f9039 to
b1949ee
Compare
b1949ee to
ac9724d
Compare
7c8ceca to
691368a
Compare
Assisted-by: Cursor
691368a to
bb292f8
Compare
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.
The copy button seems to not be working correctly when we insert the code using the directive {{#literatego}}.
As a suggestion, what would happen if we wrapped the directives in a codeblock, like this:
```go
{{#literatego ./getting-started/testdata/project/api/v1alpha1/memcached_types.go}}
```
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.
Hi @camilamacedo86 I was taking a look at the preview and noticed that the copy button is duplicated in some blocks, like in here:
But in other codeblocks, it isn't, like in here:
It led me to think that mdBook adds the copy button by default. If you take a look at the current state of the docs, that same codeblock that has duplicated buttons already features the button, as seen in here:
The codeblock that does not have a duplicated button does not feature the button in the current docs, as seen in here:
So, IMO, we could investigate what's causing the button to not be rendered in some codeblocks, instead of adding a custom script for that.
| # Enable copy button on code blocks | ||
| copy-fonts = true | ||
| # Improve code block rendering | ||
| code-block-copy-button = true |
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.
If it's set by default, should we still add this? Also, I can't see the option code-block-copy-button in the mdBook docs, which only mention copyable.
|
@camilamacedo86 I suggested ealier that we tried wrapping the And that raises the question: why do we start some parts in a markdown file, then continue the page by inserting comments in the file that was inserted? As an example, let's consider this page: https://book.kubebuilder.io/cronjob-tutorial/empty-main We start it here: https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/cronjob-tutorial/empty-main.md Then we insert this file: https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/cronjob-tutorial/testdata/emptymain.go And then we add comments to that file to continue the instructions in the page. So, couldn't we keep all the instruction in markdown files, and add only the sections of code that we need? That way, we could wrap each section in a codeblock, to be rendered properly, with the copy button. See: https://rust-lang.github.io/mdBook/format/mdbook.html?highlight=hide#including-portions-of-a-file |
The following changes impact mainly the tutorials.
To review see:
Documentation Improvements Summary
Changes
New Features:
Layout:
Content Cleanup:
}appearing outside code blocksLabel Updates:
Closes: #4862