diff --git a/buildpack.md b/buildpack.md index 6e60bb15..7373323a 100644 --- a/buildpack.md +++ b/buildpack.md @@ -21,7 +21,7 @@ This is accomplished in two phases: 2. **Development,** where the lifecycle uses those buildpacks to create a containerized development environment. ## Table of Contents - +<!-- Using https://github.com/yzhang-gh/vscode-markdown to manage toc --> 1. [Buildpack Interface](#buildpack-interface) 1. [Key](#key) 2. [Detection](#detection) diff --git a/platform.md b/platform.md index 2b30cf4b..b2bc0aca 100644 --- a/platform.md +++ b/platform.md @@ -11,45 +11,51 @@ Examples of a platform might include: 1. A cloud application platform that uses buildpacks to build source code before deployment ## Table of Contents - -1. [Platform API Version](#platform-api-version) -1. [Stacks](#stacks) - 1. [Compatibility Guarantees](#compatibility-guarantees) - 1. [Build Image](#build-image) - 1. [Run Image](#run-image) -1. [Lifecycle Interface](#lifecycle-interface) - 1. [Platform API Compatibility](#platform-api-compatibility) - 1. [Operations](#operations) - 1. [Build](#build) - 1. [Rebase](#rebase) - 1. [Launch](#launch) - 1. [Usage](#usage) - 1. [detector](#detector) - 1. [analyzer](#analyzer) - 1. [restorer](#restorer) - 1. [builder](#builder) - 1. [exporter](#exporter) - 1. [creator](#creator) - 1. [rebaser](#rebaser) - 1. [launcher](#launcher) -1. [Buildpacks](#buildpacks) - 1. [Buildpacks Directory Layout](#buildpacks-directory-layout) -1. [Security Considerations](#security-considerations) -1. [Additional Guidance](#additional-guidance) - 1. [Environment](#environment) - 1. [Caching](#caching) -1. [Data Format](#data-format) - 1. [Files](#files) - 1. [analyzed.toml (TOML)](#analyzedtoml-toml) - 1. [group.toml (TOML)](#grouptoml-toml) - 1. [metadata.toml (TOML)](#metadatatoml-toml) - 1. [order.toml (TOML)](#ordertoml-toml) - 1. [project-metadata.toml (TOML)](#project-metadatatoml-toml) - 1. [stack.toml (TOML)](#group.toml-(toml)) - 1. [Labels](#labels) - 1. [io.buildpacks.build.metadata (JSON)](#iobuildpacksbuildmetadata-json) - 1. [io.buildpacks.lifecycle.metadata (JSON)](#iobuildpackslifecyclemetadata-json) - 1. [io.buildpacks.project.metadata (JSON)](#iobuildpacksprojectmetadata-json) +<!-- Using https://github.com/yzhang-gh/vscode-markdown to manage toc --> +- [Platform Interface Specification](#platform-interface-specification) + - [Table of Contents](#table-of-contents) + - [Platform API Version](#platform-api-version) + - [Terminology](#terminology) + - [Stacks](#stacks) + - [Compatibility Guarantees](#compatibility-guarantees) + - [Build Image](#build-image) + - [Run Image](#run-image) + - [Mixins](#mixins) + - [Lifecycle Interface](#lifecycle-interface) + - [Platform API Compatibility](#platform-api-compatibility) + - [Operations](#operations) + - [Build](#build) + - [Rebase](#rebase) + - [Launch](#launch) + - [Usage](#usage) + - [`detector`](#detector) + - [`analyzer`](#analyzer) + - [Layer analysis](#layer-analysis) + - [`restorer`](#restorer) + - [Layer restoration](#layer-restoration) + - [`builder`](#builder) + - [`exporter`](#exporter) + - [`creator`](#creator) + - [`rebaser`](#rebaser) + - [`launcher`](#launcher) + - [Buildpacks](#buildpacks) + - [Buildpacks Directory Layout](#buildpacks-directory-layout) + - [Security Considerations](#security-considerations) + - [Additional Guidance](#additional-guidance) + - [Environment](#environment) + - [Caching](#caching) + - [Data Format](#data-format) + - [Files](#files) + - [`analyzed.toml` (TOML)](#analyzedtoml-toml) + - [`group.toml` (TOML)](#grouptoml-toml) + - [`metadata.toml` (TOML)](#metadatatoml-toml) + - [`order.toml` (TOML)](#ordertoml-toml) + - [`project-metadata.toml` (TOML)](#project-metadatatoml-toml) + - [`stack.toml` (TOML)](#stacktoml-toml) + - [Labels](#labels) + - [`io.buildpacks.build.metadata` (JSON)](#iobuildpacksbuildmetadata-json) + - [`io.buildpacks.lifecycle.metadata` (JSON)](#iobuildpackslifecyclemetadata-json) + - [`io.buildpacks.project.metadata` (JSON)](#iobuildpacksprojectmetadata-json) ## Platform API Version