From 1178048a084de242fb3228ce502581fcbb087e0a Mon Sep 17 00:00:00 2001 From: Anders Kaseorg Date: Thu, 4 Sep 2025 09:45:46 -0700 Subject: [PATCH] format-mdx: Add remark-gfm. Signed-off-by: Anders Kaseorg --- eslint.config.js | 1 - pnpm-lock.yaml | 3 +++ starlight_help/package.json | 8 ++++---- starlight_help/src/.remarkrc.js | 4 ++++ starlight_help/src/content/docs/guest-users.mdx | 2 +- .../src/content/docs/import-from-mattermost.mdx | 8 ++++---- .../src/content/docs/import-from-rocketchat.mdx | 2 +- .../src/content/docs/import-from-slack.mdx | 2 +- .../src/content/docs/saml-authentication.mdx | 12 ++++++------ version.py | 2 +- 10 files changed, 25 insertions(+), 19 deletions(-) diff --git a/eslint.config.js b/eslint.config.js index 5113ff9dd0..2dc11a012e 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -209,7 +209,6 @@ export default tseslint.config( "comma-spacing": "error", "import/extensions": "off", "import/unambiguous": "off", - "object-curly-spacing": "error", quotes: "error", }, }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e70c6acf7a..f58797b598 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -576,6 +576,9 @@ importers: remark-frontmatter: specifier: ^5.0.0 version: 5.0.0 + remark-gfm: + specifier: ^4.0.1 + version: 4.0.1 remark-lint-fenced-code-flag: specifier: ^4.2.0 version: 4.2.0 diff --git a/starlight_help/package.json b/starlight_help/package.json index 9a8c1ec28c..e67106d968 100644 --- a/starlight_help/package.json +++ b/starlight_help/package.json @@ -8,8 +8,8 @@ "build": "astro check && astro build", "preview": "astro preview", "astro": "astro", - "format": "remark --ext mdx --frail --output --quiet --use remark-mdx -- .", - "format-silent": "remark --ext mdx --output --silent --use remark-mdx -- ." + "format": "remark --ext mdx --frail --output --quiet -- .", + "format-silent": "remark --ext mdx --output --silent -- ." }, "dependencies": { "@astrojs/check": "^0.9.3", @@ -26,12 +26,12 @@ "sharp": "^0.34.1", "typescript": "^5.4.5", "unist-util-visit": "^5.0.0", - "unplugin-icons": "^22.1.0", - "@types/mdast": "^4.0.4" + "unplugin-icons": "^22.1.0" }, "devDependencies": { "remark-cli": "^12.0.1", "remark-frontmatter": "^5.0.0", + "remark-gfm": "^4.0.1", "remark-lint-fenced-code-flag": "^4.2.0", "remark-lint-file-extension": "^3.0.1", "remark-lint-final-definition": "^4.0.2", diff --git a/starlight_help/src/.remarkrc.js b/starlight_help/src/.remarkrc.js index 997808c6e7..3936726e51 100644 --- a/starlight_help/src/.remarkrc.js +++ b/starlight_help/src/.remarkrc.js @@ -10,6 +10,7 @@ */ import remarkFrontmatter from "remark-frontmatter"; +import remarkGfm from "remark-gfm"; import remarkLintFencedCodeFlag from "remark-lint-fenced-code-flag"; import remarkLintFileExtension from "remark-lint-file-extension"; import remarkLintFinalDefinition from "remark-lint-final-definition"; @@ -24,6 +25,7 @@ import remarkLintNoFileNameIrregularCharacters from "remark-lint-no-file-name-ir import remarkLintNoFileNameMixedCase from "remark-lint-no-file-name-mixed-case"; import remarkLintNoUnusedDefinitions from "remark-lint-no-unused-definitions"; import remarkLintUnorderedListMarkerStyle from "remark-lint-unordered-list-marker-style"; +import remarkMdx from "remark-mdx"; import remarkPresentLintMarkdownStyleGuide from "remark-preset-lint-markdown-style-guide"; import remarkLintRulesLintRecommended from "remark-preset-lint-recommended"; import remarkStringify from "remark-stringify"; @@ -52,6 +54,8 @@ const remarkLintRules = { /** @type {Preset} */ const config = { plugins: [ + remarkGfm, + remarkMdx, [remarkFrontmatter, ["yaml"]], remarkLintRules, // The format step was converting our ordered list items to have diff --git a/starlight_help/src/content/docs/guest-users.mdx b/starlight_help/src/content/docs/guest-users.mdx index 7ba73efcc3..edbe1cf9e4 100644 --- a/starlight_help/src/content/docs/guest-users.mdx +++ b/starlight_help/src/content/docs/guest-users.mdx @@ -110,7 +110,7 @@ is which user IDs exist, and Self-hosted organizations can disable API access to availability updates by [configuring](https://zulip.readthedocs.io/en/stable/production/settings.html) `CAN_ACCESS_ALL_USERS_GROUP_LIMITS_PRESENCE = True`. For performance reasons, - this is recommended only for organizations with up to ~100 users. + this is recommended only for organizations with up to \~100 users. diff --git a/starlight_help/src/content/docs/import-from-mattermost.mdx b/starlight_help/src/content/docs/import-from-mattermost.mdx index f549662032..b3b3ae7c1a 100644 --- a/starlight_help/src/content/docs/import-from-mattermost.mdx +++ b/starlight_help/src/content/docs/import-from-mattermost.mdx @@ -255,10 +255,10 @@ keep in mind about the import process: and [how users can join your organization](/help/restrict-account-creation). * Mattermost's user roles are mapped to Zulip's [user roles](/help/user-roles) in the following way: - | Mattermost role | Zulip role | - |-------------------------|---------------| - | Team administrator | Owner | - | Member | Member | + | Mattermost role | Zulip role | + | ------------------ | ---------- | + | Team administrator | Owner | + | Member | Member | * Mattermost's export tool does not support exporting user avatars or message edit history. * Direct messages will only be imported from Mattermost workspaces containing diff --git a/starlight_help/src/content/docs/import-from-rocketchat.mdx b/starlight_help/src/content/docs/import-from-rocketchat.mdx index 531c18ce3d..24dd1ae43f 100644 --- a/starlight_help/src/content/docs/import-from-rocketchat.mdx +++ b/starlight_help/src/content/docs/import-from-rocketchat.mdx @@ -120,7 +120,7 @@ keep in mind about the import process: * Rocket.Chat user roles are mapped to Zulip's [user roles](/help/user-roles) in the following way: | Rocket.Chat role | Zulip role | - |------------------|------------| + | ---------------- | ---------- | | Admin | Owner | | User | Member | | Guest | Guest | diff --git a/starlight_help/src/content/docs/import-from-slack.mdx b/starlight_help/src/content/docs/import-from-slack.mdx index ff580f20c7..068ea1ae8c 100644 --- a/starlight_help/src/content/docs/import-from-slack.mdx +++ b/starlight_help/src/content/docs/import-from-slack.mdx @@ -158,7 +158,7 @@ in mind about the import process: * Slack's user roles are mapped to Zulip's [user roles](/help/user-roles) in the following way: | Slack role | Zulip role | - |-------------------------|---------------| + | ----------------------- | ------------- | | Workspace Primary Owner | Owner | | Workspace Owner | Owner | | Workspace Admin | Administrator | diff --git a/starlight_help/src/content/docs/saml-authentication.mdx b/starlight_help/src/content/docs/saml-authentication.mdx index 562301f083..b0b9cce580 100644 --- a/starlight_help/src/content/docs/saml-authentication.mdx +++ b/starlight_help/src/content/docs/saml-authentication.mdx @@ -80,12 +80,12 @@ providers. * **ACS URL Validator**: `https://auth.zulipchat.com/complete/saml/` 1. In the **Parameters** section, add the following custom parameters. Set the **Include in SAML assertion** flag on each parameter. - | Field name | Value - |--- |--- - | email | Email - | first\_name | First Name - | last\_name | Last Name - | username | Email + | Field name | Value | + | ----------- | ---------- | + | email | Email | + | first\_name | First Name | + | last\_name | Last Name | + | username | Email | 1. * Your organization's URL * The **issuer URL** from the **SSO** section. It contains required **Identity Provider** metadata. diff --git a/version.py b/version.py index e0291510e9..5cda0c6b22 100644 --- a/version.py +++ b/version.py @@ -49,4 +49,4 @@ API_FEATURE_LEVEL = 425 # historical commits sharing the same major version, in which case a # minor version bump suffices. -PROVISION_VERSION = (343, 1) # bumped 2025-09-03 to add eslint-plugin-mdx +PROVISION_VERSION = (344, 0) # bumped 2025-09-04 to add remark-gfm