-
Notifications
You must be signed in to change notification settings - Fork 23
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
New approach to referencing content in code blocks. #469
Conversation
…n alignment with asciidoc. Signed-off-by: John Krug <john.krug@suse.com>
Part of the work on #467. Any thoughts? Objections? I think this is all OK. It's small changes. I don't think it affects usability or readability. Just different approaches. It will make the cross-fertilization of community and product docs a bit easier. The reference mark in the code block (the (1)) is a bit indistinct in the Docusaurus/community version. Can be fixed with a styling update. |
✅ Deploy Preview for silly-bunny-8cedd0 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
Obviously the docusarurus highlight mode is nicer, but this approach works too. This resembles closely what we were doing before we learnt about that docusaurus feature :)
I'm fine moving forward with that
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.
I'm fine too.
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.
I'm also ok with it too.
Fixes #467 |
…code blocks Signed-off-by: John Krug <john.krug@suse.com>
To be more in alignment with asciidoc, as used in product documentation for SUSE Admission Policy Manager.
To see the asciidoc version, for comparison, in product docs: https://github.com/jhkrug/kubewarden-product-docs/blob/40c59ee37760b9bb28f0c56e3c4fc545a40661b0/docs/next/modules/en/pages/reference/monitor-mode.adoc?plain=1#L30-L58