From b5bd6cca647cb048f9434db3231e0025c7bfdf73 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Thu, 6 Feb 2025 14:50:16 +1100 Subject: [PATCH] Add back local editing instructions --- en/contribute/docs.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/en/contribute/docs.md b/en/contribute/docs.md index 88a845ab5ce0..ae543b216810 100644 --- a/en/contribute/docs.md +++ b/en/contribute/docs.md @@ -142,6 +142,17 @@ Build the library locally to test that any changes you have made have rendered p This will be something like: `http://localhost:5173/px4_user_guide/`. - Stop serving using **CTRL+C** in the terminal prompt. +1. Open previewed pages in your local editor: + + First specify a local text editor file using the `EDITOR` environment variable, before calling `yarn start` to preview the library. + For example, on Windows command line you can enable VSCode as your default editor by entering: + + ```sh + set EDITOR=code + ``` + + The **Open in your editor** link at the bottom of each page will then open the current page in the editor (this replaces the _Open in GitHub_ link). + 1. You can build the library as it would be done for deployment: ```sh