From 531a52ccd3de7cb0e256797d03ac7fb530287aa8 Mon Sep 17 00:00:00 2001 From: Dylan Barva Date: Sun, 2 Aug 2026 13:15:13 -0700 Subject: [PATCH 1/4] Add citation for named() --- .remarkrc.mjs | 2 ++ package.json | 1 + pnpm-lock.yaml | 3 +++ .../stage1/stage1b/commands-and-mechanisms.mdx | 4 +++- 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.remarkrc.mjs b/.remarkrc.mjs index 3a3379bb..99c90548 100644 --- a/.remarkrc.mjs +++ b/.remarkrc.mjs @@ -1,5 +1,6 @@ import remarkFrontmatter from 'remark-frontmatter'; import remarkMdx from 'remark-mdx'; +import remarkGfm from 'remark-gfm'; import remarkPresetLintRecommended from 'remark-preset-lint-recommended'; import remarkNoInlineCodeFences from './src/plugins/remark-no-inline-code-fences.mjs'; import remarkNoHtmlLinks from './src/plugins/remark-no-html-links.mjs'; @@ -9,6 +10,7 @@ export default { plugins: [ remarkFrontmatter, remarkMdx, + remarkGfm, remarkPresetLintRecommended, remarkNoInlineCodeFences, remarkNoHtmlLinks, diff --git a/package.json b/package.json index b561e642..a57b5c4f 100644 --- a/package.json +++ b/package.json @@ -59,6 +59,7 @@ "prettier-plugin-sentences-per-line": "^0.2.3", "remark-cli": "^12.0.1", "remark-frontmatter": "^5.0.0", + "remark-gfm": "^4.0.1", "remark-lint-no-dead-urls": "^2.0.1", "remark-mdx": "^3.1.1", "remark-preset-lint-recommended": "^7.0.1", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 72d6e939..34998d6b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -93,6 +93,9 @@ importers: remark-frontmatter: specifier: ^5.0.0 version: 5.0.0 + remark-gfm: + specifier: ^4.0.1 + version: 4.0.1 remark-lint-no-dead-urls: specifier: ^2.0.1 version: 2.0.1 diff --git a/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx b/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx index ddbebda1..229eaf5c 100644 --- a/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx +++ b/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx @@ -47,7 +47,7 @@ Notice that: when the command runs, like a method body. - This command will print "Full Speed Baby!" once before commanding the motor to spin at max speed. -- The `named("Set to Full Throttle")` call is required to create a `Command`. +- The `named("Set to Full Throttle")` call is required to create a `Command`.[^1] This allows coders to distinguish this command from others when debugging their code. To change the priority of the command, simply add a `withPriority(int)` call before @@ -135,3 +135,5 @@ That means you can run multiple commands in sequence: ```java #commandSequence ``` + +[^1]: [`NeedsNameBuilderStage.named()`]() From 3e847c6ceb765bca152e058864c9c1fc52ef79b5 Mon Sep 17 00:00:00 2001 From: Dylan Barva Date: Sat, 15 Aug 2026 18:02:35 -0700 Subject: [PATCH 2/4] Handle gfm rules in lint correctly --- .remarkrc.mjs | 2 ++ package.json | 1 + pnpm-lock.yaml | 3 +++ 3 files changed, 6 insertions(+) diff --git a/.remarkrc.mjs b/.remarkrc.mjs index 99c90548..bd148838 100644 --- a/.remarkrc.mjs +++ b/.remarkrc.mjs @@ -5,6 +5,7 @@ import remarkPresetLintRecommended from 'remark-preset-lint-recommended'; import remarkNoInlineCodeFences from './src/plugins/remark-no-inline-code-fences.mjs'; import remarkNoHtmlLinks from './src/plugins/remark-no-html-links.mjs'; import remarkLintNoDeadUrls from 'remark-lint-no-dead-urls'; +import remarkLintNoLiteralUrls from 'remark-lint-no-literal-urls'; export default { plugins: [ @@ -12,6 +13,7 @@ export default { remarkMdx, remarkGfm, remarkPresetLintRecommended, + [remarkLintNoLiteralUrls, false], remarkNoInlineCodeFences, remarkNoHtmlLinks, [ diff --git a/package.json b/package.json index a57b5c4f..56b3f457 100644 --- a/package.json +++ b/package.json @@ -61,6 +61,7 @@ "remark-frontmatter": "^5.0.0", "remark-gfm": "^4.0.1", "remark-lint-no-dead-urls": "^2.0.1", + "remark-lint-no-literal-urls": "^4.0.1", "remark-mdx": "^3.1.1", "remark-preset-lint-recommended": "^7.0.1", "starlight-links-validator": "^0.20.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 34998d6b..eb375e84 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -99,6 +99,9 @@ importers: remark-lint-no-dead-urls: specifier: ^2.0.1 version: 2.0.1 + remark-lint-no-literal-urls: + specifier: ^4.0.1 + version: 4.0.1 remark-mdx: specifier: ^3.1.1 version: 3.1.1 From d772ac1ede09c808402af0b8268e493275cc8ea7 Mon Sep 17 00:00:00 2001 From: Dylan Barva Date: Sat, 15 Aug 2026 18:16:44 -0700 Subject: [PATCH 3/4] Add heading for References --- astro.config.mjs | 5 +++++ .../stage1/stage1b/commands-and-mechanisms.mdx | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/astro.config.mjs b/astro.config.mjs index dbe7e048..e86cbcaa 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -26,6 +26,11 @@ export default defineConfig({ remarkCodeRegion, ], }), + remarkRehype: { + footnoteLabel: 'References', + // Default is `{ className: ['sr-only'] }`, which hides the heading. + footnoteLabelProperties: {}, + }, }, integrations: [ diff --git a/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx b/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx index 229eaf5c..c025a939 100644 --- a/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx +++ b/src/content/docs/learning-course/stage1/stage1b/commands-and-mechanisms.mdx @@ -136,4 +136,4 @@ That means you can run multiple commands in sequence: ``` -[^1]: [`NeedsNameBuilderStage.named()`]() +[^1]: WPILib JavaDocs for [`NeedsNameBuilderStage.named()`]() From e7cb573830e4231c20f285eee85c2d589caa0d66 Mon Sep 17 00:00:00 2001 From: Dylan Barva Date: Sat, 15 Aug 2026 18:24:09 -0700 Subject: [PATCH 4/4] use h4 instead for label --- astro.config.mjs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/astro.config.mjs b/astro.config.mjs index e86cbcaa..19cfa56f 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -28,7 +28,8 @@ export default defineConfig({ }), remarkRehype: { footnoteLabel: 'References', - // Default is `{ className: ['sr-only'] }`, which hides the heading. + footnoteLabelTagName: 'h4', + // override properties so footnote label is visible footnoteLabelProperties: {}, }, },