From 443e149169cdd3413962dab81178eb65a9d36f6e Mon Sep 17 00:00:00 2001 From: Katie Hoesley <39041092+katiehoesley@users.noreply.github.com> Date: Mon, 12 Aug 2024 12:01:04 -0600 Subject: [PATCH] Fixes rendering in linting guide (#443) ## What changed? - Fixes rendering in linting guide --------- Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com> --- .../lint-a-document-with-dx-linter-script.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 guides/lint-a-document-with-dx-linter-script.md diff --git a/guides/lint-a-document-with-dx-linter-script.md b/guides/lint-a-document-with-dx-linter-script.md new file mode 100644 index 000000000..0f4a78a6a --- /dev/null +++ b/guides/lint-a-document-with-dx-linter-script.md @@ -0,0 +1,21 @@ +# How to lint a document with the DX linter script + +The Developer Documentation team uses a custom script to lint doc files before they are pushed. This linter covers everything our in-house Style Guide does, saving you time. + +Run the script using the CLI to get your PR submission nearly perfect in no time. + +> ⚠️ Before running the script, ensure your nvm version is at least 18. You can update the nvm version using the following command: +> +> `nvm use 18` + +1. Open terminal and navigate to the file's folder. + +2. Run `npx github:bigcommerce/dev-docs-style-guide-linter ./{{yourfilename}}.mdx.` + +Example: `npx github:bigcommerce/dev-docs-style-guide-linter ./start/authentication/index.mdx` + +> ℹ️ **NOTE:** Ensure your file name has the correct path. + +3. Review the flagged items and make necessary updates. + +4. Repeat Step 2 to re-run the linter.