Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 5.49 KB

development.md

File metadata and controls

91 lines (60 loc) · 5.49 KB
Raw

Development

This document describes the process for running this application on your local computer.

Getting started

This site is powered by Node.js! ✨ 🐢 🚀 ✨

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. If you're using nodenv, read the nodenv docs for instructions on switching Node.js versions.

You'll want to install Git LFS.

Once you've installed Node.js (which includes the popular npm package manager) and Git LFS, open Terminal and run the following:

git clone https://github.com/github/docs
cd docs
npm ci
npm run build
npm start

You should now have a running server! Visit 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.

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
  • npm run build creates static assets, such as JavaScript and CSS files

Using GitHub Codespaces

As an alternative, you can simply use GitHub Codespaces.

In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser.

Debugging with VS Code

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.
  2. In VS Code, click on the Debugging icon in the Activity Bar to bring up the Debug view.
  3. 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.
  4. Select the node process that's started with the --inspect flag.
  5. Debugger has now been attached. Enjoy!

For more detailed instructions, please see this VS Code recipe. You can also learn more about debugging using VS Code here.

Viewing a top-level table of contents

While running the local server, you can visit localhost:4000/dev-toc to view a top-level TOC of all the content in the site. This page is not available on https://docs.github.com. It was created for internal GitHub writers' use.

At the /dev-toc path, you'll see a list of available versions. Click a version, and a list of products will appear. Note that the TOC content is versioned. If you are viewing the GitHub.com version and you click the Enterprise Admin product, it will be empty, because there isn't any Admin content available on that version.

Enabling different languages

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.

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. A few years after that it was migrated to Nanoc, another Ruby static site generator.

Today it's a dynamic Node.js webserver powered by Express, using middleware 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.

The tooling for this site has changed over the years, but many of the tried-and-true authoring conventions of the original Jekyll site have been preserved:

  • Content is written in Markdown files, which live in the content directory.
  • Content can use the Liquid templating language.
  • Files in the data directory are available to templates via the {% data %} tag.
  • Markdown files can contain frontmatter.
  • The redirect_from Jekyll plugin behavior is supported.

For more info about working with this site, check out these READMEs: