Skip to content

Commit e2fc48f

Browse files
authored
Merge pull request #394 from PeterDaveHelloKitchen/Add-Table-of-Contents
Add "Table of Contents" in README and docs
2 parents 34ed25d + f5113b0 commit e2fc48f

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,29 @@
77

88
The official Node.js docker image, made with love by the node community.
99

10+
## Table of Contents
11+
12+
- [What is Node.js?](#what-is-nodejs)
13+
- [Usage](#usage)
14+
- [How to use this image](#how-to-use-this-image)
15+
- [Create a `Dockerfile` in your Node.js app project](#create-a-dockerfile-in-your-nodejs-app-project)
16+
- [Notes](#notes)
17+
- [Run a single Node.js script](#run-a-single-nodejs-script)
18+
- [Verbosity](#verbosity)
19+
- [Dockerfile](#dockerfile)
20+
- [Docker Run](#docker-run)
21+
- [NPM run](#npm-run)
22+
- [Image Variants](#image-variants)
23+
- [`node:<version>`](#nodeversion)
24+
- [`node:alpine`](#nodealpine)
25+
- [`node:onbuild`](#nodeonbuild)
26+
- [`node:slim`](#nodeslim)
27+
- [License](#license)
28+
- [Supported Docker versions](#supported-docker-versions)
29+
- [Governance and Current Members](#governance-and-current-members)
30+
- [Docker Working Group Members](#docker-working-group-members)
31+
- [Docker Working Group Collaborators](#docker-working-group-collaborators)
32+
1033
## What is Node.js?
1134

1235
Node.js is a platform built on Chrome's JavaScript runtime for easily building

docs/BestPractices.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Docker and Node.js Best Practices
22

3+
## Table of Contents
4+
5+
- [Environment Variables](#environment-variables)
6+
- [Handling Kernel Signals](#handling-kernel-signals)
7+
- [Non-root User](#non-root-user)
8+
- [Memory](#memory)
9+
- [CMD](#cmd)
10+
- [Docker Run](#docker-run)
11+
- [Security](#security)
12+
313
## Environment Variables
414

515
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.

0 commit comments

Comments
 (0)