From 6d3f35370c0c5f5bd2dfc33e84f763f76c401163 Mon Sep 17 00:00:00 2001 From: Anil Seervi Date: Wed, 20 Oct 2021 20:40:35 +0530 Subject: [PATCH] Fix ambiguous keyboard shortcut to stop local server --- contributing/development.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/contributing/development.md b/contributing/development.md index cf63b10c72d8..62aa369c757f 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -8,7 +8,7 @@ This site is powered by Node.js! :sparkles: :turtle: :rocket: :sparkles: It runs on macOS, Windows, and Linux environments. -You'll need Node.js version 16 to run the site. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) for instructions on switching Node.js versions. +You'll need Node.js version 16 to run the site. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](https://github.com/nodenv/nodenv#readme) for instructions on switching Node.js versions. You'll want to [install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage). @@ -24,7 +24,7 @@ npm start You should now have a running server! Visit [localhost:4000](http://localhost:4000) in your browser. It will automatically restart as you make changes to site content. -When you're ready to stop your local server, type CTRLc in your terminal window. +When you're ready to stop your local server, type Ctrl+C in your terminal window. Note that `npm ci` and `npm run build` are steps that should typically only need to be run once each time you pull the latest for a branch. - `npm ci` does a clean install of dependencies, without updating the `package-lock.json` file @@ -42,7 +42,7 @@ This repo has configuration for debugging with VS Code's built-in Node Debugger. 1. After running the build steps, start the app by running `npm run debug`. 1. In VS Code, click on the Debugging icon in the Activity Bar to bring up the Debug view. -1. In the Debug View, select the **'Node: Nodemon'** configuration, then press F5 or click the green play button. You should see all of your running node processes. +1. In the Debug View, select the **'Node: Nodemon'** configuration, then press F5 or click the green play button. You should see all of your running node processes. 1. Select the node process that's started with the `--inspect` flag. 1. Debugger has now been attached. Enjoy! @@ -58,11 +58,11 @@ At the `/dev-toc` path, you'll see a list of available versions. Click a version By default the local server won't run with all supported languages enabled. If you need to run the server with a particular language, you can temporarily edit the `start` script in `package.json` and update the `ENABLED_LANGUAGES` variable. For example, to enable Japanese and Portuguese, you can set it to `ENABLED_LANGUAGES='en,ja,pt'` and then you need to restart the server for the change to take effect. -The supported language codes are defined in [lib/lanuages.js](../lib/languages.js). +The supported language codes are defined in [lib/languages.js](../lib/languages.js). ## Site structure -This site was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by [Jekyll](https://jekyllrb.com/). A few years after that it was migrated to [Nanoc](https://nanoc.ws/), another Ruby static site generator. +This site was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by [Jekyll](https://jekyllrb.com/). A few years after that it was migrated to [Nanoc](https://nanoc.app/), another Ruby static site generator. Today it's a dynamic Node.js webserver powered by Express, using [middleware](../middleware/README.md) to support proper HTTP redirects, language header detection, and dynamic content generation to support the various flavors of GitHub's product documentation, like GitHub.com and GitHub Enterprise Server.