From 4d00a1261dcb626e9ab92c16d0739bd92f4f63c2 Mon Sep 17 00:00:00 2001 From: Jeff Escalante Date: Tue, 14 Apr 2020 19:48:08 -0400 Subject: [PATCH] add clearer safe write note to readme --- website/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/README.md b/website/README.md index f1643cd544..c0f418bf80 100644 --- a/website/README.md +++ b/website/README.md @@ -10,7 +10,9 @@ If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript ## Running the Site Locally -The website can be run locally through node.js or Docker. If you choose to run through Docker, everything will be a little bit slower due to the additional overhead, so for frequent contributors it may be worth it to use node. Also if you are a vim user, it's also worth noting that vim's swapfile usage can cause issues for the live reload functionality. In order to avoid these issues, make sure you have run `:set backupcopy=yes` within vim. +The website can be run locally through node.js or Docker. If you choose to run through Docker, everything will be a little bit slower due to the additional overhead, so for frequent contributors it may be worth it to use node. + +> **Note:** If you are using a text editor that uses a "safe write" save style such as **vim** or **goland**, this can cause issues with the live reload in development. If you turn off safe write, this should solve the problem. In vim, this can be done by running `:set backupcopy=yes`. In goland, search the settings for "safe write" and turn that setting off. ### With Docker