Skip to content

Fix CONTRIBUTING.MDX formatting snafu introduced in PR 2989 #3073

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

Merged
merged 6 commits into from
Aug 24, 2025
Merged

Fix CONTRIBUTING.MDX formatting snafu introduced in PR 2989 #3073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7fbf48f
Fix broken code blocks, exclude CONTRIBUTING.mdx from prettier
rinOfTheStars Jul 25, 2025
42779be
Merge branch 'cursorless-dev:main' into contributing-docs-fix
rinOfTheStars Aug 8, 2025
2896fa3
Merge branch 'cursorless-dev:main' into contributing-docs-fix
rinOfTheStars Aug 24, 2025
bb50415
fixed white space issues?
rinOfTheStars Aug 24, 2025
9b054c9
Remove unwanted new lines in code blocks
AndreasArvidsson Aug 24, 2025
ed4242e
Merge branch 'contributing-docs-fix' of github.com:rinOfTheStars/curs…
AndreasArvidsson Aug 24, 2025
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
2 changes: 2 additions & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
pnpm-lock.yaml

.github/PULL_REQUEST_TEMPLATE.md
# Formatting breaks code blocks nested within tabs
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
37 changes: 26 additions & 11 deletions packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode" default>
`bash code --profile=cursorlessDevelopment`
```bash
code --profile=cursorlessDevelopment
```
</TabItem>
<TabItem value="vscodium" label="VSCodium">
`bash codium --profile=cursorlessDevelopment`
```bash
codium --profile=cursorlessDevelopment
```
</TabItem>
</Tabs>

Expand All @@ -43,10 +47,16 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode">
```bash pnpm init-vscode-sandbox```
```bash
pnpm init-vscode-sandbox
```
</TabItem>
<TabItem value="vscodium" label="VSCodium">
`bash pnpm init-vscode-sandbox --codium` VSCodium users will also need to
```bash
pnpm init-vscode-sandbox --codium
```

VSCodium users will also need to
manually download and install the `jrieken:vscode-tree-sitter-query`
extension, as it is [currently not
avalible](https://github.com/jrieken/vscode-tree-sitter-query/issues/28)
Expand All @@ -64,12 +74,14 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode">
`bash code --profile=cursorlessDevelopment --install-extension
some.extension`
```bash
code --profile=cursorlessDevelopment --install-extension some.extension
```
</TabItem>
<TabItem value="vscodium" label="VSCodium">
`bash codium --profile=cursorlessDevelopment --install-extension
some.extension`
```bash
codium --profile=cursorlessDevelopment --install-extension some.extension
```
</TabItem>
</Tabs>

Expand Down Expand Up @@ -138,11 +150,14 @@ Once you have your package then you can install it into the sandbox using the fo

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode">
`bash code --profile=cursorlessDevelopment --install-extension bundle.vsix`
```bash
code --profile=cursorlessDevelopment --install-extension bundle.vsix
```
</TabItem>
<TabItem value="vscodium" label="VSCodium">
`bash codium --profile=cursorlessDevelopment --install-extension
bundle.vsix`
```bash
Copy link
Member

Choose a reason for hiding this comment

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

I suspect if we put blank lines around the code blocks prettier will have a better time

Copy link
Member

Choose a reason for hiding this comment

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

Thank you! That worked.

codium --profile=cursorlessDevelopment --install-extension bundle.vsix
```
</TabItem>
</Tabs>

Expand Down
Loading