Skip to content

docs: create a markdown code snippet file to make it easier for contributors #15611

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
Merged
merged 2 commits into from
Nov 21, 2024
Merged

docs: create a markdown code snippet file to make it easier for contributors #15611

merged 2 commits into from
Nov 21, 2024

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngert EdwardAngert commented Nov 20, 2024 •
edited
Loading

adds snippets to make some of the docs markdown components a little easier to use

  • wraps selected text where it seems appropriate
  • limits code block languages (these are suggestions, you can choose from the list or enter anything)

tabs example:

tabs gif

@EdwardAngert EdwardAngert added the docs Area: coder.com/docs label Nov 20, 2024
@EdwardAngert EdwardAngert self-assigned this Nov 20, 2024
matifali
matifali approved these changes Nov 21, 2024
View reviewed changes
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not familiar with how these snippets work but trust your suggestions.

Does these require some specific extension or are a native vscode feature?

@EdwardAngert
Copy link
Contributor Author

@matifali native!

it should work as-is. I have it set to call with something like #tabs, but you can also use the VSCode built-in Suggestions thing with CTRL+space to bring up the whole list

@EdwardAngert EdwardAngert enabled auto-merge (squash) November 21, 2024 22:08
@EdwardAngert EdwardAngert merged commit 684e75e into main Nov 21, 2024
21 checks passed
@EdwardAngert EdwardAngert deleted the docs-md-code-snippets branch November 21, 2024 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matifali matifali matifali approved these changes

@ericpaulsen ericpaulsen Awaiting requested review from ericpaulsen

@bpmct bpmct Awaiting requested review from bpmct

@stirby stirby Awaiting requested review from stirby

Assignees

@EdwardAngert EdwardAngert

Labels
docs Area: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@EdwardAngert @matifali