Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Annotate yaml configs with comments beside the yaml #367

Open
1 of 3 tasks
q0rban opened this issue Sep 6, 2023 · 2 comments · May be fixed by #372
Open
1 of 3 tasks

Annotate yaml configs with comments beside the yaml #367

q0rban opened this issue Sep 6, 2023 · 2 comments · May be fixed by #372

Comments

@q0rban
Copy link
Contributor

q0rban commented Sep 6, 2023 •
edited
Loading

GitHub docs uses a yaml annotation formatter that pulls comments off to the side of the yaml and highlights them along with the block of code. This would be great for our config examples!

https://docs.github.com/en/contributing/syntax-and-versioning-for-github-docs/annotating-code-examples#rendered-example

Annotating code examples - GitHub Docs 2023-09-06 11-02-13
  • Figure out what library is being used
  • Determine if this is compatible with our existing syntax highlighter
  • Integrate with our hugo-learn theme if possible, or find another theme that it works with
@q0rban
Copy link
Contributor Author

q0rban commented Sep 6, 2023 •
edited
Loading

I think this is the JS that's being used: https://github.com/github/docs/blob/774c5d0d9d75f4e62296e1b007c22e4f99010cda/src/content-render/unified/annotate.js#L52

@KeyboardCowboy KeyboardCowboy linked a pull request Sep 19, 2023 that will close this issue
Draft
@KeyboardCowboy
Copy link
Contributor

Github Docs is a node module and it's loading annotate.js somewhere in the dependency chain from its package.js file. I don't think that will play very easily with this theme since it's not a node module, but maybe I'm a little out of my tech depth.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add GitHub Docs Annotations to Code Blocks TugboatQA/docs
2 participants
@q0rban @KeyboardCowboy