feat(packages): use website captures in packages' READMEs

plouc · Dec 26, 2021 · f9f0acb · f9f0acb
1 parent 1daa7fe
commit f9f0acb
Show file tree

Hide file tree

Showing 65 changed files with 44 additions and 51 deletions.
diff --git a/packages/bar/README.md b/packages/bar/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/bar)
 
-![Bar](https://raw.githubusercontent.com/plouc/nivo/master/packages/bar/doc/bar.png)
+![Bar](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/bar.png)
 
 ## BarCanvas
 
 [documentation](http://nivo.rocks/bar/canvas)
 
-![BarCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/bar/doc/bar-canvas.png)
+![BarCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/bar-canvas.png)
diff --git a/packages/bar/doc/bar-canvas.png b/packages/bar/doc/bar-canvas.png
diff --git a/packages/bar/doc/bar.png b/packages/bar/doc/bar.png
diff --git a/packages/bullet/README.md b/packages/bullet/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/bullet)
 
-![Bullet](https://raw.githubusercontent.com/plouc/nivo/master/packages/bullet/doc/bullet.png)
+![Bullet](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/bullet.png)
diff --git a/packages/bullet/doc/bullet.png b/packages/bullet/doc/bullet.png
diff --git a/packages/bump/README.md b/packages/bump/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/bump/)
 
-![Bump](https://raw.githubusercontent.com/plouc/nivo/master/packages/bump/doc/bump.png)
+![Bump](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/bump.png)
 
 ## AreaBump
 
 [documentation](http://nivo.rocks/area-bump/)
 
-![Bump](https://raw.githubusercontent.com/plouc/nivo/master/packages/bump/doc/area-bump.png)
+![Bump](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/area-bump.png)
diff --git a/packages/bump/doc/area-bump.png b/packages/bump/doc/area-bump.png
diff --git a/packages/bump/doc/bump.png b/packages/bump/doc/bump.png
diff --git a/packages/calendar/README.md b/packages/calendar/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/calendar)
 
-![Calendar](https://raw.githubusercontent.com/plouc/nivo/master/packages/calendar/doc/calendar.png)
+![Calendar](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/calendar.png)
diff --git a/packages/calendar/doc/calendar.png b/packages/calendar/doc/calendar.png
diff --git a/packages/chord/README.md b/packages/chord/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/chord)
 
-![Chord](https://raw.githubusercontent.com/plouc/nivo/master/packages/chord/doc/chord.png)
+![Chord](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/chord.png)
 
 ## ChordCanvas
 
 [documentation](http://nivo.rocks/chord/canvas)
 
-![ChordCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/chord/doc/chord-canvas.png)
+![ChordCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/chord-canvas.png)
diff --git a/packages/chord/doc/chord-canvas.png b/packages/chord/doc/chord-canvas.png
diff --git a/packages/chord/doc/chord.png b/packages/chord/doc/chord.png
diff --git a/packages/circle-packing/README.md b/packages/circle-packing/README.md
@@ -6,16 +6,16 @@
 
 [documentation](http://nivo.rocks/circle-pack)
 
-![CirclePacking](https://raw.githubusercontent.com/plouc/nivo/master/packages/circle-packing/doc/circle-packing.png)
+![CirclePacking](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/circle-packing.png)
 
 ## CirclePackingHtml
 
 [documentation](http://nivo.rocks/circle-pack/html)
 
-![CirclePackingHtml](https://raw.githubusercontent.com/plouc/nivo/master/packages/circle-packing/doc/circle-packing-html.png)
+![CirclePackingHtml](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/circle-packing-html.png)
 
 ## CirclePackingCanvas
 
 [documentation](http://nivo.rocks/circle-packing/canvas)
 
-![CirclePackingCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/circle-packing/doc/circle-packing-canvas.png)
+![CirclePackingCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/circle-packing-canvas.png)
diff --git a/packages/circle-packing/doc/circle-packing-canvas.png b/packages/circle-packing/doc/circle-packing-canvas.png
diff --git a/packages/circle-packing/doc/circle-packing-html.png b/packages/circle-packing/doc/circle-packing-html.png
diff --git a/packages/circle-packing/doc/circle-packing.png b/packages/circle-packing/doc/circle-packing.png
diff --git a/packages/funnel/README.md b/packages/funnel/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/funnel)
 
-![Funnel](https://raw.githubusercontent.com/plouc/nivo/master/packages/funnel/doc/funnel.png)
+![Funnel](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/funnel.png)
diff --git a/packages/funnel/doc/funnel.png b/packages/funnel/doc/funnel.png
diff --git a/packages/geo/README.md b/packages/geo/README.md
@@ -6,22 +6,22 @@
 
 [documentation](http://nivo.rocks/geomap)
 
-![GeoMap](https://raw.githubusercontent.com/plouc/nivo/master/packages/geo/doc/geomap.png)
+![GeoMap](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/geomap.png)
 
 ## GeoMapCanvas
 
 [documentation](http://nivo.rocks/geomap/canvas)
 
-![GeoMapCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/geo/doc/geomap-canvas.png)
+![GeoMapCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/geomap-canvas.png)
 
 ## Choropleth
 
 [documentation](http://nivo.rocks/choropleth)
 
-![Choropleth](https://raw.githubusercontent.com/plouc/nivo/master/packages/geo/doc/choropleth.png)
+![Choropleth](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/choropleth.png)
 
 ## ChoroplethCanvas
 
 [documentation](http://nivo.rocks/choropleth/canvas)
 
-![ChoroplethCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/geo/doc/choropleth-canvas.png)
+![ChoroplethCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/choropleth-canvas.png)
diff --git a/packages/geo/doc/choropleth-canvas.png b/packages/geo/doc/choropleth-canvas.png
diff --git a/packages/geo/doc/choropleth.png b/packages/geo/doc/choropleth.png
diff --git a/packages/geo/doc/geomap-canvas.png b/packages/geo/doc/geomap-canvas.png
diff --git a/packages/geo/doc/geomap.png b/packages/geo/doc/geomap.png
diff --git a/packages/heatmap/README.md b/packages/heatmap/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/heatmap)
 
-![HeatMap](https://raw.githubusercontent.com/plouc/nivo/master/packages/heatmap/doc/heatmap.png)
+![HeatMap](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/heatmap.png)
 
 ## HeatMapCanvas
 
 [documentation](http://nivo.rocks/heatmap/canvas)
 
-![HeatmapCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/heatmap/doc/heatmap-canvas.png)
+![HeatmapCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/heatmap-canvas.png)
diff --git a/packages/heatmap/doc/heatmap-canvas.png b/packages/heatmap/doc/heatmap-canvas.png
diff --git a/packages/heatmap/doc/heatmap.png b/packages/heatmap/doc/heatmap.png
diff --git a/packages/line/README.md b/packages/line/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/line/)
 
-![Line](https://raw.githubusercontent.com/plouc/nivo/master/packages/line/doc/line.png)
+![Line](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/line.png)
 
 ## LineCanvas
 
 [documentation](http://nivo.rocks/line/canvas/)
 
-![LineCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/line/doc/line-canvas.png)
+![LineCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/line-canvas.png)
diff --git a/packages/line/doc/line-canvas.png b/packages/line/doc/line-canvas.png
diff --git a/packages/line/doc/line.png b/packages/line/doc/line.png
diff --git a/packages/marimekko/README.md b/packages/marimekko/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/marimekko/)
 
-![Marimekko](https://raw.githubusercontent.com/plouc/nivo/master/packages/marimekko/doc/marimekko.png)
+![Marimekko](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/marimekko.png)
diff --git a/packages/marimekko/doc/marimekko.png b/packages/marimekko/doc/marimekko.png
diff --git a/packages/network/README.md b/packages/network/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/network/)
 
-![Network](https://raw.githubusercontent.com/plouc/nivo/master/packages/network/doc/network.png)
+![Network](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/network.png)
 
 ## NetworkCanvas
 
 [documentation](http://nivo.rocks/network/canvas/)
 
-![NetworkCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/network/doc/network-canvas.png)
+![NetworkCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/network-canvas.png)
diff --git a/packages/network/doc/network-canvas.png b/packages/network/doc/network-canvas.png
diff --git a/packages/network/doc/network.png b/packages/network/doc/network.png
diff --git a/packages/parallel-coordinates/README.md b/packages/parallel-coordinates/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/parallel-coordinates)
 
-![ParallelCoordinates](https://raw.githubusercontent.com/plouc/nivo/master/packages/parallel-coordinates/doc/parallel-coordinates.png)
+![ParallelCoordinates](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/parallel-coordinates.png)
 
 ## ParallelCoordinatesCanvas
 
 [documentation](http://nivo.rocks/parallel-coordinates/canvas)
 
-![ParallelCoordinatesCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/parallel-coordinates/doc/parallel-coordinates-canvas.png)
+![ParallelCoordinatesCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/parallel-coordinates-canvas.png)
diff --git a/packages/parallel-coordinates/doc/parallel-coordinates-canvas.png b/packages/parallel-coordinates/doc/parallel-coordinates-canvas.png
diff --git a/packages/parallel-coordinates/doc/parallel-coordinates.png b/packages/parallel-coordinates/doc/parallel-coordinates.png
diff --git a/packages/pie/README.md b/packages/pie/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/pie)
 
-![Pie](https://raw.githubusercontent.com/plouc/nivo/master/packages/pie/doc/pie.png)
+![Pie](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/pie.png)
diff --git a/packages/pie/doc/pie.png b/packages/pie/doc/pie.png
diff --git a/packages/radar/README.md b/packages/radar/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/radar)
 
-![Radar](https://raw.githubusercontent.com/plouc/nivo/master/packages/radar/doc/radar.png)
+![Radar](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/radar.png)
diff --git a/packages/radar/doc/radar.png b/packages/radar/doc/radar.png
diff --git a/packages/radial-bar/README.md b/packages/radial-bar/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/radial-bar)
 
-![RadialBar](https://raw.githubusercontent.com/plouc/nivo/master/packages/radial-bar/doc/radial-bar.png)
+![RadialBar](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/radial-bar.png)
diff --git a/packages/radial-bar/doc/radial-bar.png b/packages/radial-bar/doc/radial-bar.png
diff --git a/packages/sankey/README.md b/packages/sankey/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/heatmap/sankey)
 
-![Sankey](https://raw.githubusercontent.com/plouc/nivo/master/packages/sankey/doc/sankey.png)
+![Sankey](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/sankey.png)
diff --git a/packages/sankey/doc/sankey.png b/packages/sankey/doc/sankey.png
diff --git a/packages/scatterplot/README.md b/packages/scatterplot/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/scatterplot)
 
-![ScatterPlot](https://raw.githubusercontent.com/plouc/nivo/master/packages/scatterplot/doc/scatterplot.png)
+![ScatterPlot](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/scatterplot.png)
 
 ## ScatterPlotCanvas
 
 [documentation](http://nivo.rocks/scatterplot/canvas)
 
-![ScatterPlotCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/scatterplot/doc/scatterplot-canvas.png)
+![ScatterPlotCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/scatterplot-canvas.png)
diff --git a/packages/scatterplot/doc/scatterplot-canvas.png b/packages/scatterplot/doc/scatterplot-canvas.png
diff --git a/packages/scatterplot/doc/scatterplot.png b/packages/scatterplot/doc/scatterplot.png
diff --git a/packages/stream/README.md b/packages/stream/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/stream)
 
-![Stream](https://raw.githubusercontent.com/plouc/nivo/master/packages/stream/doc/stream.png)
+![Stream](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/stream.png)
diff --git a/packages/stream/doc/stream.png b/packages/stream/doc/stream.png
diff --git a/packages/sunburst/README.md b/packages/sunburst/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/sunburst)
 
-![Sunburst](https://raw.githubusercontent.com/plouc/nivo/master/packages/sunburst/doc/sunburst.png)
+![Sunburst](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/sunburst.png)
diff --git a/packages/sunburst/doc/sunburst.png b/packages/sunburst/doc/sunburst.png
diff --git a/packages/swarmplot/README.md b/packages/swarmplot/README.md
@@ -6,10 +6,10 @@
 
 [documentation](http://nivo.rocks/swarmplot)
 
-![SwarmPlot](https://raw.githubusercontent.com/plouc/nivo/master/packages/swarmplot/doc/swarmplot.png)
+![SwarmPlot](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/swarmplot.png)
 
 ## SwarmPlotCanvas
 
 [documentation](http://nivo.rocks/swarmplot/canvas)
 
-![SwarmPlotCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/swarmplot/doc/swarmplot-canvas.png)
+![SwarmPlotCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/swarmplot-canvas.png)
diff --git a/packages/treemap/README.md b/packages/treemap/README.md
@@ -6,16 +6,16 @@
 
 [documentation](http://nivo.rocks/treemap)
 
-![TreeMap](https://raw.githubusercontent.com/plouc/nivo/master/packages/treemap/doc/treemap.png)
+![TreeMap](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/treemap.png)
 
 ## TreeMapHtml
 
 [documentation](http://nivo.rocks/treemap/html)
 
-![TreeMapHtml](https://raw.githubusercontent.com/plouc/nivo/master/packages/treemap/doc/treemap-html.png)
+![TreeMapHtml](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/treemap-html.png)
 
 ## TreeMapCanvas
 
 [documentation](http://nivo.rocks/treemap/canvas)
 
-![TreeMapCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/treemap/doc/treemap-canvas.png)
+![TreeMapCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/treemap-canvas.png)
diff --git a/packages/treemap/doc/treemap-canvas.png b/packages/treemap/doc/treemap-canvas.png
diff --git a/packages/treemap/doc/treemap-html.png b/packages/treemap/doc/treemap-html.png
diff --git a/packages/treemap/doc/treemap.png b/packages/treemap/doc/treemap.png
diff --git a/packages/voronoi/README.md b/packages/voronoi/README.md
@@ -6,4 +6,4 @@
 
 [documentation](http://nivo.rocks/voronoi)
 
-![Voronoi](https://raw.githubusercontent.com/plouc/nivo/master/packages/voronoi/doc/voronoi.png)
+![Voronoi](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/voronoi.png)
diff --git a/packages/voronoi/doc/voronoi.png b/packages/voronoi/doc/voronoi.png
diff --git a/packages/waffle/README.md b/packages/waffle/README.md
@@ -6,16 +6,16 @@
 
 [documentation](http://nivo.rocks/waffle)
 
-![Waffle](https://raw.githubusercontent.com/plouc/nivo/master/packages/waffle/doc/waffle.png)
+![Waffle](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/waffle.png)
 
 ## WaffleHtml
 
 [documentation](http://nivo.rocks/waffle/html)
 
-![WaffleHtml](https://raw.githubusercontent.com/plouc/nivo/master/packages/waffle/doc/waffle-html.png)
+![WaffleHtml](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/waffle-html.png)
 
 ## WaffleCanvas
 
 [documentation](http://nivo.rocks/waffle/canvas)
 
-![WaffleCanvas](https://raw.githubusercontent.com/plouc/nivo/master/packages/waffle/doc/waffle-canvas.png)
+![WaffleCanvas](https://raw.githubusercontent.com/plouc/nivo/master/website/src/assets/captures/waffle-canvas.png)
diff --git a/packages/waffle/doc/waffle-canvas.png b/packages/waffle/doc/waffle-canvas.png
diff --git a/packages/waffle/doc/waffle-html.png b/packages/waffle/doc/waffle-html.png
diff --git a/packages/waffle/doc/waffle.png b/packages/waffle/doc/waffle.png
diff --git a/scripts/capture.js b/scripts/capture.js
@@ -22,13 +22,7 @@ const projectDir = process.cwd()
 const websiteDir = Path.join(projectDir, 'website')
 const websiteCapturesDir = Path.join(websiteDir, 'src', 'assets', 'captures')
 const websiteIconsDir = Path.join(websiteDir, 'src', 'assets', 'icons')
-const getPackageDir = (pkg) => Path.join(projectDir, 'packages', pkg)
-const getPackageDocDir = (pkg) => Path.join(getPackageDir(pkg), 'doc')
 const getChartFileName = (chart, flavor) => `${chart}${flavor !== DEFAULT_FLAVOR ? `-${flavor}` : ''}.png`
-const getChartDocFilePath = (pkg, chart, flavor) => Path.join(
-    getPackageDocDir(pkg),
-    getChartFileName(chart, flavor)
-)
 const getChartWebsiteFilePath = (chart, flavor) => Path.join(
     websiteCapturesDir,
     getChartFileName(chart, flavor)
@@ -72,20 +66,19 @@ const captureChart = async (page, { pkg, chart, flavor, theme }) => {
 
     const clip = await element.boundingBox()
 
-    const docFilePath = getChartDocFilePath(pkg, chart, flavor)
     const websiteFilePath = getChartWebsiteFilePath(chart, flavor)
 
     // initially saved to the package doc dir
     await page.screenshot({
-        path: docFilePath,
+        path: websiteFilePath,
         clip,
         omitBackground: true,
     })
 
     // also save a copy in the website, for social images
     await fs.copyFile(docFilePath, websiteFilePath)
 
-    console.log(chalk`{green saved to {white ${docFilePath}} and {white ${websiteFilePath}}}`)
+    console.log(chalk`{green saved to {white ${websiteFilePath}}}`)
     console.log('')
 }