Merge pull request #394 from PeterDaveHelloKitchen/Add-Table-of-Contents

Add "Table of Contents" in README and docs
This commit is contained in:
Christopher Horrell 2017-05-03 16:07:59 -04:00 committed by GitHub
commit e2fc48f3da
2 changed files with 33 additions and 0 deletions

View File

@ -7,6 +7,29 @@
The official Node.js docker image, made with love by the node community.
## Table of Contents
- [What is Node.js?](#what-is-nodejs)
- [Usage](#usage)
- [How to use this image](#how-to-use-this-image)
- [Create a `Dockerfile` in your Node.js app project](#create-a-dockerfile-in-your-nodejs-app-project)
- [Notes](#notes)
- [Run a single Node.js script](#run-a-single-nodejs-script)
- [Verbosity](#verbosity)
- [Dockerfile](#dockerfile)
- [Docker Run](#docker-run)
- [NPM run](#npm-run)
- [Image Variants](#image-variants)
- [`node:<version>`](#nodeversion)
- [`node:alpine`](#nodealpine)
- [`node:onbuild`](#nodeonbuild)
- [`node:slim`](#nodeslim)
- [License](#license)
- [Supported Docker versions](#supported-docker-versions)
- [Governance and Current Members](#governance-and-current-members)
- [Docker Working Group Members](#docker-working-group-members)
- [Docker Working Group Collaborators](#docker-working-group-collaborators)
## What is Node.js?
Node.js is a platform built on Chrome's JavaScript runtime for easily building

View File

@ -1,5 +1,15 @@
# Docker and Node.js Best Practices
## Table of Contents
- [Environment Variables](#environment-variables)
- [Handling Kernel Signals](#handling-kernel-signals)
- [Non-root User](#non-root-user)
- [Memory](#memory)
- [CMD](#cmd)
- [Docker Run](#docker-run)
- [Security](#security)
## Environment Variables
Run with `NODE_ENV` set to `production`. This is the way you would pass in secrets and other runtime configurations to your application as well.