Skip to content

Commit 8dcb78b

Browse files
committed
fixup tabel of content - add maintainer - add h-lines
1 parent 22abf04 commit 8dcb78b

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,17 @@ Plotly.js can be used to produce dozens of chart types and visualizations, inclu
1919
## Table of contents
2020

2121
* [Quick start options](#quick-start-options)
22-
* [Modules](#modules)
23-
* [Building plotly.js](#building-plotlyjs)
22+
* [Partial bundles](#partial-bundles)
23+
* [Alternative ways to require or build plotly.js](#alternative-ways-to-require-or-build-plotlyjs)
2424
* [Bugs and feature requests](#bugs-and-feature-requests)
2525
* [Documentation](#documentation)
2626
* [Contributing](#contributing)
2727
* [Community](#community)
28-
* [Notable Contributors](#creators)
28+
* [Versioning](#versioning)
29+
* [Notable contributors](#creators)
2930
* [Copyright and license](#copyright-and-license)
3031

32+
---
3133
## Quick start options
3234

3335
### Install with npm
@@ -70,6 +72,7 @@ and use the plotly.js `dist` file(s). More info [here](https://github.com/plotly
7072

7173
#### Read the [Getting started page](https://plotly.com/javascript/getting-started/) for more examples.
7274

75+
---
7376
## Partial bundles
7477

7578
There are two kinds of plotly.js partial bundles:
@@ -119,38 +122,45 @@ Or simply on one line:
119122
npm run partial-bundle -- --unminified --out myScatters --traces scatter,scattergl,scatter3d --transforms none
120123
```
121124

125+
---
122126
## Alternative ways to require or build plotly.js
123127
If your library needs to bundle or directly require [plotly.js/lib/index.js](https://github.com/plotly/plotly.js/blob/master/lib/index.js) or parts of its modules similar to [index-basic](https://github.com/plotly/plotly.js/blob/master/lib/index-basic.js) in some other way than via an official or a custom bundle, or in case you want to tweak the default build configurations of `browserify` or `webpack`, etc. then please visit [`BUILDING.md`](https://github.com/plotly/plotly.js/blob/master/BUILDING.md).
124128

129+
---
125130
## Bugs and feature requests
126131

127132
Have a bug or a feature request? Please [open a Github issue](https://github.com/plotly/plotly.js/issues/new) keeping in mind the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/.github/ISSUE_TEMPLATE.md). You may also want to read about [how changes get made to Plotly.js](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md)
128133

134+
---
129135
## Documentation
130136

131137
Official plotly.js documentation is hosted at [https://plotly.com/javascript](https://plotly.com/javascript).
132138

133139
These pages are generated by the Plotly [graphing-library-docs repo](https://github.com/plotly/graphing-library-docs) built with [Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages.
134140
For more info about contributing to Plotly documentation, please read through [contributing guidelines](https://github.com/plotly/graphing-library-docs/blob/master/README.md).
135141

142+
---
136143
## Contributing
137144

138145
Please read through our [contributing guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md). Included are directions for opening issues, using plotly.js in your project and notes on development.
139146

147+
---
140148
## Community
141149

142150
* Follow [@plotlygraphs](https://twitter.com/plotlygraphs) on Twitter for the latest Plotly news.
143151
* Implementation help may be found on community.plot.com (tagged [`plotly-js`](https://community.plotly.com/c/plotly-js)) or
144152
on Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
145153
* Developers should use the keyword `plotly` on packages which modify or add to the functionality of plotly.js when distributing through [npm](https://www.npmjs.com/browse/keyword/plotly).
146154

155+
---
147156
## Versioning
148157

149158
This project is maintained under the [Semantic Versioning guidelines](https://semver.org/).
150159

151160
See the [Releases section](https://github.com/plotly/plotly.js/releases) of our GitHub project for changelogs for each release version of plotly.js.
152161

153-
## Notable Contributors
162+
---
163+
## Notable contributors
154164

155165
Plotly.js is at the core of a large and dynamic ecosystem with many contributors who file issues, reproduce bugs, suggest improvements, write code in this repo (and other upstream or downstream ones) and help users in the Plotly community forum. The following people deserve special recognition for their outsized contributions to this ecosystem:
156166

@@ -159,7 +169,7 @@ Plotly.js is at the core of a large and dynamic ecosystem with many contributors
159169
|**Alex C. Johnson**| [@alexcjohnson](https://github.com/alexcjohnson) | | Active, Maintainer |
160170
|**Mojtaba Samimi** | [@archmoj](https://github.com/archmoj) | [@solarchvision](https://twitter.com/solarchvision) | Active, Maintainer |
161171
|**Antoine Roy-Gobeil** | [@antoinerg](https://github.com/antoinerg) | | Active, Maintainer |
162-
|**Nicolas Kruchten** | [@nicolaskruchten](https://github.com/nicolaskruchten) | [@nicolaskruchten](https://twitter.com/nicolaskruchten) | Active |
172+
|**Nicolas Kruchten** | [@nicolaskruchten](https://github.com/nicolaskruchten) | [@nicolaskruchten](https://twitter.com/nicolaskruchten) | Active, Maintainer |
163173
|**Jon Mease** | [@jonmmease](https://github.com/jonmmease) | [@jonmmease](https://twitter.com/jonmmease) | Active |
164174
|**Étienne Tétreault-Pinard**| [@etpinard](https://github.com/etpinard) | [@etpinard](https://twitter.com/etpinard) | Hall of Fame |
165175
|**Mikola Lysenko**| [@mikolalysenko](https://github.com/mikolalysenko) | [@MikolaLysenko](https://twitter.com/MikolaLysenko) | Hall of Fame |
@@ -174,6 +184,7 @@ Plotly.js is at the core of a large and dynamic ecosystem with many contributors
174184
|**Chris Parmer**| [@chriddyp](https://github.com/chriddyp) | | Hall of Fame |
175185
|**Alex Vados**| [@alexander-daniel](https://github.com/alexander-daniel) | | Hall of Fame |
176186

187+
---
177188
## Copyright and license
178189

179190
Code and documentation copyright 2021 Plotly, Inc.

0 commit comments

Comments
 (0)