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

Add documentation on .cheat.md #961

Merged
merged 4 commits into from
Mar 27, 2025

Conversation

kit494way
Copy link
Contributor

I think documentation on .cheat.md is helpful.

@kit494way kit494way requested a review from denisidoro as a code owner March 20, 2025 09:39
@kit494way
Copy link
Contributor Author

The format error is already fixed in another pr #958. So please merge #958 before this pr.

> If you are editing cheatsheets in Visual Studio Code, you could enable syntax highlighting
> by installing [this extension](https://marketplace.visualstudio.com/items?itemName=yanivmo.navi-cheatsheet-language).

If you use `.cheat.md` as an extension of cheat files, you can place commands in code blocks fenced with triple backticks (```` ``` ````).

Choose a reason for hiding this comment

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

This is not restricted to .cheat.md extension... It works for .cheat files too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks!

@alexis-opolka alexis-opolka merged commit 6bdc59a into denisidoro:master Mar 27, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants