Skip to content

Commit 212f64a

Browse files
Generate reference files as markdown instead of relying on react component (#3307)
1 parent 9ca1aab commit 212f64a

147 files changed

Lines changed: 1494 additions & 506 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/app-web-docs/src/docs/components/ReferenceEntry.tsx‎

Lines changed: 0 additions & 114 deletions
This file was deleted.

‎packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,8 @@ export function ScopeVisualizer({ languageId, scopeTypeType }: Props) {
4646
const [scopes] = useState(
4747
getScopeFixtures(scopeTests, languageId, scopeTypeType),
4848
);
49-
const [rangeType, setRangeType] = useState<RangeType>(
50-
scopeTypeType != null ? "blend" : "content",
51-
);
52-
const [renderWhitespace, setRenderWhitespace] = useState(
53-
scopeTypeType != null,
54-
);
49+
const [rangeType, setRangeType] = useState<RangeType>("content");
50+
const [renderWhitespace, setRenderWhitespace] = useState(true);
5551

5652
if (scopes.internal.length === 0 && scopes.public.length === 0) {
5753
return null;
Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Add selection
42

5-
<ActionReference id="addSelection" />
3+
Cursorless ID: `addSelection`
4+
5+
## Spoken form
6+
7+
Default: `append`
8+
9+
## Syntax
10+
11+
- append `<target>`: Adds `<target>` to the current selection set.
Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Add selection after
42

5-
<ActionReference id="addSelectionAfter" />
3+
Cursorless ID: `addSelectionAfter`
4+
5+
## Spoken form
6+
7+
Default: `append post`
8+
9+
## Syntax
10+
11+
- append post `<target>`: Adds empty selection after `<target>` to the current selection set.
Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Add selection before
42

5-
<ActionReference id="addSelectionBefore" />
3+
Cursorless ID: `addSelectionBefore`
4+
5+
## Spoken form
6+
7+
Default: `append pre`
8+
9+
## Syntax
10+
11+
- append pre `<target>`: Adds empty selection before `<target>` to the current selection set.
Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Apply formatter
42

5-
<ActionReference id="applyFormatter" />
3+
Cursorless ID: `applyFormatter`
4+
5+
## Spoken form
6+
7+
Default: `format`
8+
9+
## Syntax
10+
11+
- format `<formatter>` at `<target>`: Reformat `<target>` as `<formatter>`.
Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Break line
42

5-
<ActionReference id="breakLine" />
3+
Cursorless ID: `breakLine`
4+
5+
## Spoken form
6+
7+
Default: `break`
8+
9+
## Syntax
10+
11+
- break `<target>`: Breaks the line before `<target>`.
Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Call as function
42

5-
<ActionReference id="callAsFunction" />
3+
Cursorless ID: `callAsFunction`
4+
5+
## Spoken form
6+
7+
Default: `call`
8+
9+
## Syntax
10+
11+
- call `<target>`: Insert call to `<target>` on selection.
12+
- call `<target 1>` on `<target 2>`: Insert call to `<target 1>` on `<target 2>`.
Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Change
42

5-
<ActionReference id="clearAndSetSelection" />
3+
Cursorless ID: `clearAndSetSelection`
4+
5+
## Spoken form
6+
7+
Default: `change`\
8+
Legacy: `clear`
9+
10+
## Syntax
11+
12+
- change `<target>`: Change `<target>` by clearing it and leaving the cursor in its place.
Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
import { ActionReference } from "@site/src/docs/components/ReferenceEntry";
2-
31
# Copy to clipboard
42

5-
<ActionReference id="copyToClipboard" />
3+
Cursorless ID: `copyToClipboard`
4+
5+
## Spoken form
6+
7+
Default: `copy`
8+
9+
## Syntax
10+
11+
- copy `<target>`: Copy `<target>` to clipboard.

0 commit comments

Comments
 (0)