Skip to content

Commit fe62b07

Browse files
committed
clean up table of content
1 parent 4ed7f07 commit fe62b07

File tree

2 files changed

+15
-23
lines changed

2 files changed

+15
-23
lines changed

.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"markdown.extension.toc.levels": "1..2",
3+
}

README.md

+12-23
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</p>
77
<br />
88

9-
# RDKit for JavaScript (Official)
9+
# RDKit for JavaScript (Official) <!-- omit in toc -->
1010

1111
[![Build Status](https://dev.azure.com/rdkit-js/rdkit-js/_apis/build/status/rdkit.rdkit-js?branchName=master)](https://dev.azure.com/rdkit-js/rdkit-js/_build/latest?definitionId=1&branchName=master)
1212
[![License](https://img.shields.io/github/license/rdkit/rdkit)](https://github.com/rdkit/rdkit-js/blob/master/LICENSE)
@@ -17,26 +17,15 @@
1717
[![NPM Yearly Downloads](https://img.shields.io/npm/dy/@rdkit/rdkit)](https://www.npmjs.com/package/@rdkit/rdkit)
1818
[![NPM Total Downloads](https://img.shields.io/npm/dt/@rdkit/rdkit?label=total%20downloads)](https://www.npmjs.com/package/@rdkit/rdkit)
1919

20-
## Table of contents
21-
22-
- [RDKit for JavaScript (Official)](#rdkit-for-javascript-official)
23-
- [Table of contents](#table-of-contents)
24-
- [Introduction](#introduction)
25-
- [What is the scope of this repository](#what-is-the-scope-of-this-repository)
26-
- [What is NOT the scope of this repository](#what-is-not-the-scope-of-this-repository)
27-
- [Install](#install)
28-
- [Usage](#usage)
29-
- [Using RDKit.js package assets](#using-rdkitjs-package-assets)
30-
- [Option 1: Use the npm package distribution files](#option-1-use-the-npm-package-distribution-files)
31-
- [Option 2: Use the remote distribution files from unpkg.com](#option-2-use-the-remote-distribution-files-from-unpkgcom)
32-
- [Running RDKit.js in your JavaScript code](#running-rdkitjs-in-your-javascript-code)
33-
- [Using RDKit.js with JavaScript](#using-rdkitjs-with-javascript)
34-
- [Using RDKit.js with React.js](#using-rdkitjs-with-reactjs)
35-
- [Contributing](#contributing)
36-
- [NPM Releases](#npm-releases)
37-
- [Important note on npm versioning](#important-note-on-npm-versioning)
38-
- [Website deployments](#website-deployments)
39-
- [Maintainers](#maintainers)
20+
## Table of contents <!-- omit in toc -->
21+
22+
- [Introduction](#introduction)
23+
- [Install](#install)
24+
- [Usage](#usage)
25+
- [Contributing](#contributing)
26+
- [Release process](#release-process)
27+
- [Website deployment](#website-deployment)
28+
- [Maintainers](#maintainers)
4029

4130
## Introduction
4231

@@ -135,7 +124,7 @@ To contribute to the plain javascript examples, read [this sub-repository README
135124

136125
To contribute to the React.js examples, read [this sub-repository README](https://github.com/rdkit/rdkit-js/tree/master/examples/react).
137126

138-
## NPM Releases
127+
## Release process
139128

140129
NPM releases are currently semi-automated with the following azure pipeline:
141130

@@ -171,7 +160,7 @@ With this in mind, we will attempt the following versioning scheme of the packag
171160
> Example: when a bug fix is made in a React component built on top of RDKit for version 2022.03.3, a new npm release `2022.03.3-1.0.1` will be published.
172161
> Example: when a new React component is built on top of RDKit for version 2022.03.3, a new npm release `2022.03.3-1.1.0` will be published.
173162
174-
## Website deployments
163+
## Website deployment
175164

176165
Website deployments for [rdkitjs.com](https://rdkitjs.com) are automated via [Vercel](https://vercel.com/) for each commit merged or pushed to the master branch.
177166

0 commit comments

Comments
 (0)