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

Expand cspell ignore instructions #2252

Merged
merged 9 commits into from
Jan 6, 2025
Merged
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ npm run check

There are two ways to deal with cSpell incorrectly complaining about a word, such as abbreviations.

1. Ignore the word in the local markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere.
1. Ignore the word in the local markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere (inside a markdown cell, in the source part). Note that in the text editor, each line is surrounded by quotes and ends with \n. So it looks like this: "{/* cspell:ignore hellllooooo, ayyyyy */}\n"

```
{/* cspell:ignore hellllooooo, ayyyyy */}
Expand Down Expand Up @@ -444,7 +444,7 @@ Refer to the [Common Markdown syntax](https://commonmark.org/) for a primer on M

## How to add a new page

Choose which existing folder from `docs/` your new page belongs to (probably `guides`).
Choose which existing folder from `docs/` your new page belongs to (probably `guides`) (probably `guides`).
beckykd marked this conversation as resolved.
Show resolved Hide resolved

Next, choose the file name. The file name will determine the URL. For example, `start/my-new-page.mdx` results in the URL `start/my-new-page`. Choose a file name that will be stable over the page's lifespan and that is unlikely to clash with other topics. Use `-` rather than `_` as the delimiter. You can also ask for help choosing a name in the GitHub issue or pull request.

Expand Down
Loading