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.

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

feat: add syntax highlighting for the github unfurl integration #178

Closed
bguiz opened this issue Jun 5, 2023 · 1 comment · Fixed by #194
Closed

feat: add syntax highlighting for the github unfurl integration #178

bguiz opened this issue Jun 5, 2023 · 1 comment · Fixed by #194
Labels
improvement Improvement to existing integration integration-github-files Issues around the GitHub Files integration

Comments

@bguiz
Copy link

bguiz commented Jun 5, 2023

What

  • Add an additional parameter to the github-unfurl integration to specify the syntax highlight language
    • This is optional, and if not specified, will default to a language inferred from the file extension where present, and default to no highlighting when no file extension is present
  • Add an additional parameter to the github-unfurl integration to specify the syntax highlight theme
    • This is optional, and if not specified, will default to the syntax highlight theme that is default for the current gitbook theme

Why

Satisfy the following user stories:

  • As a technical documenter, I would like to migrate existing code examples from inline (within markdown code blocks) to reference the same code within a github repo, and have it look the same as before.
  • As a developer reading technical documentation, I would like to see syntax highlighting so that I can mentally parse the code shown in the tutorial/ article more intuitively.

Refs

@addisonschultz addisonschultz added improvement Improvement to existing integration integration-github-files Issues around the GitHub Files integration labels Jun 6, 2023
@addisonschultz
Copy link
Collaborator

addisonschultz commented Jul 6, 2023

Hey @bguiz, I've made some updates that should be now published and available ツ

Pull request: #194

I've tested them both quite a bit, but please let me know if there's anything else I missed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvement to existing integration integration-github-files Issues around the GitHub Files integration
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@bguiz @addisonschultz and others