From 0fda6d46ab6d563f8f6820d75add327f83ff757c Mon Sep 17 00:00:00 2001 From: SheetJS Date: Thu, 11 Apr 2024 21:04:37 -0400 Subject: [PATCH] upgrade docusaurus to 3.2.1 --- README.md | 4 +- .../01-installation/02-frameworks.md | 4 +- docz/docs/02-getting-started/04-zen.md | 4 +- docz/docs/03-demos/01-math/01-summary.md | 62 ++++-- docz/docs/03-demos/01-math/09-danfojs.md | 8 +- docz/docs/03-demos/01-math/11-tensorflow.md | 4 +- docz/docs/03-demos/01-math/index.md | 8 +- docz/docs/03-demos/02-frontend/01-kaioken.md | 4 +- docz/docs/03-demos/02-frontend/02-react.md | 4 +- docz/docs/03-demos/02-frontend/03-angular.md | 4 +- docz/docs/03-demos/02-frontend/04-vue.md | 4 +- .../docs/03-demos/02-frontend/07-angularjs.md | 4 +- docz/docs/03-demos/02-frontend/index.md | 6 +- docz/docs/03-demos/12-static/12-astro.md | 2 +- .../docs/03-demos/17-mobile/01-reactnative.md | 4 +- docz/docs/03-demos/17-mobile/index.md | 6 +- .../03-demos/19-desktop/06-reactnative.md | 4 +- docz/docs/03-demos/23-data/10-sql.md | 7 +- docz/docs/03-demos/27-local/09-indexeddb.md | 4 +- docz/docs/03-demos/30-cloud/index.md | 4 +- .../03-demos/32-extensions/03-excelapi.md | 6 +- docz/docs/03-demos/37-bigdata/02-worker.md | 7 +- docz/docs/03-demos/37-bigdata/index.md | 7 +- docz/docs/03-demos/42-engines/21-boa.md | 4 +- docz/docs/03-demos/42-engines/index.md | 2 +- docz/docs/03-demos/index.md | 27 ++- docz/docs/06-solutions/01-input.md | 22 ++- docz/docs/06-solutions/03-processing.md | 2 +- docz/docs/06-solutions/05-output.md | 18 +- docz/docs/07-csf/07-features/08-rowprops.md | 7 +- docz/docs/08-api/07-utilities/01-array.md | 26 ++- docz/docs/08-api/07-utilities/03-html.md | 2 +- docz/docs/09-miscellany/02-errors.md | 2 +- docz/docusaurus.config.js | 17 +- docz/package.json | 35 ++-- docz/src/theme/Admonition/Layout/index.js | 39 ++++ .../Admonition/{ => Layout}/styles.module.css | 4 + docz/src/theme/Admonition/index.js | 186 ++---------------- docz/src/theme/prism-include-languages.js | 40 ++-- 39 files changed, 285 insertions(+), 319 deletions(-) create mode 100644 docz/src/theme/Admonition/Layout/index.js rename docz/src/theme/Admonition/{ => Layout}/styles.module.css (83%) diff --git a/README.md b/README.md index 1317316..b11f29d 100644 --- a/README.md +++ b/README.md @@ -119,8 +119,8 @@ function SheetJSTestDropbox() { ## Other Notes -`src/theme/Admonition` was swizzled from 2.4.1 to enable `pass` for hiding +`src/theme/Admonition` was swizzled from 3.2.1 to enable `pass` for hiding header text. See Docusaurus issue 8568 for more details. -`src/theme/prism-include-languages.js` was swizzled from 2.4.1 to support the +`src/theme/prism-include-languages.js` was swizzled from 3.2.1 to support the Liquid language. See Docusaurus issue 6872 for more details. \ No newline at end of file diff --git a/docz/docs/02-getting-started/01-installation/02-frameworks.md b/docz/docs/02-getting-started/01-installation/02-frameworks.md index aa32e56..1d1f9b6 100644 --- a/docz/docs/02-getting-started/01-installation/02-frameworks.md +++ b/docz/docs/02-getting-started/01-installation/02-frameworks.md @@ -50,7 +50,7 @@ Once installed, the library can be imported under the name `xlsx`: import { read, writeFileXLSX } from "xlsx"; ``` -The ["Bundlers" demo](/docs/demos/bundler) includes examples for specific tools. +The ["Bundlers" demo](/docs/demos/frontend/bundler) includes complete examples. :::tip pass @@ -203,7 +203,7 @@ var XLSX = require("xlsx"); var read = XLSX.read, utils = XLSX.utils; ``` -The ["Bundlers" demo](/docs/demos/bundler) includes examples for specific tools. +The ["Bundlers" demo](/docs/demos/frontend/bundler) includes complete examples. ### Dynamic Imports diff --git a/docz/docs/02-getting-started/04-zen.md b/docz/docs/02-getting-started/04-zen.md index c59f749..20a7f61 100644 --- a/docz/docs/02-getting-started/04-zen.md +++ b/docz/docs/02-getting-started/04-zen.md @@ -19,8 +19,8 @@ The ["Common Spreadsheet Format"](/docs/csf/general) is a simple object representation of the core concepts of a workbook. [Utilities](/docs/api/utilities/) provide low-level tools for working with the object. -For friendly JS processing, there are utility functions for converting parts of -a worksheet to/from an Array of Arrays. The [Tutorial](/docs/getting-started/example) +SheetJS provides convenient methods for processing common JavaScript data +structures. The [Export Tutorial](/docs/getting-started/examples/export) combines powerful JS Array methods with a network request library to download data, select the information we want and create a workbook file. diff --git a/docz/docs/03-demos/01-math/01-summary.md b/docz/docs/03-demos/01-math/01-summary.md index 3e10e33..63f4a4b 100644 --- a/docz/docs/03-demos/01-math/01-summary.md +++ b/docz/docs/03-demos/01-math/01-summary.md @@ -66,7 +66,9 @@ The idiomatic JavaScript representation of the dataset is an array of objects. Variable names are typically taken from the first row. Those names are used as keys in each observation. -
SpreadsheetJS Data
+ + +
SpreadsheetJS Data
![`pres.xlsx` data](pathname:///pres.png) @@ -518,47 +520,83 @@ for(var n = 1, mean = 0; n <= x.length; ++n) mean += (x[n-1] - mean)/n; Let $M[x;m] = \frac{1}{m}\sum_{i=1}^{m}x_m$ be the mean of the first $m$ elements. Then: - + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$M[x;m+1]$ - + $= \frac{1}{m+1}\sum_{i=1}^{m+1} x_i$ -
  +
  $= \frac{1}{m+1}\sum_{i=1}^{m} x_i + \frac{x_{m+1}}{m+1}$ -
  +
  $= \frac{m}{m+1}(\frac{1}{m}\sum_{i=1}^{m} x_i) + \frac{x_{m+1}}{m+1}$ -
  +
  $= \frac{m}{m+1}M[x;m] + \frac{x_{m+1}}{m+1}$ -
  +
  $= (1 - \frac{1}{m+1})M[x;m] + \frac{x_{m+1}}{m+1}$ -
  +
  $= M[x;m] + \frac{x_{m+1}}{m+1} - \frac{1}{m+1}M[x;m]$ -
  +
  $= M[x;m] + \frac{1}{m+1}(x_{m+1}-M[x;m])$ -
+
$new\_mean$ - + $= old\_mean + (x_{m+1}-old\_mean) / (m+1)$ -
+
Switching to zero-based indexing, the relation matches the following expression: diff --git a/docz/docs/03-demos/01-math/09-danfojs.md b/docz/docs/03-demos/01-math/09-danfojs.md index 6280e2e..b6e436f 100644 --- a/docz/docs/03-demos/01-math/09-danfojs.md +++ b/docz/docs/03-demos/01-math/09-danfojs.md @@ -42,7 +42,9 @@ The DanfoJS `DataFrame`[^1] represents two-dimensional tabular data. It is the starting point for most DanfoJS data processing tasks. A `DataFrame` typically corresponds to one SheetJS worksheet[^2]. -
SpreadsheetDanfoJS DataFrame
+ + +
SpreadsheetDanfoJS DataFrame
![`pres.xlsx` data](pathname:///pres.png) @@ -294,11 +296,11 @@ function DanfoToXLS() { [^1]: See ["Dataframe"](https://danfo.jsdata.org/api-reference/dataframe) in the DanfoJS documentation [^2]: See ["Sheet Objects"](/docs/csf/sheet) [^3]: See ["danfo.readExcel"](https://danfo.jsdata.org/api-reference/input-output/danfo.read_excel) in the DanfoJS documentation. -[^4]: See ["Reading Files"](/docs/api/parse-options/#parsing-options) for the full list of parsing options. +[^4]: See ["Reading Files"](/docs/api/parse-options#parsing-options) for the full list of parsing options. [^5]: See ["File API" in "Local File Access"](/docs/demos/local/file#file-api) for more details. [^6]: See ["danfo.toExcel"](https://danfo.jsdata.org/api-reference/input-output/danfo.to_excel) in the DanfoJS documentation. [^7]: See [`writeFile` in "Writing Files"](/docs/api/write-options) -[^8]: See ["Writing Files"](/docs/api/write-options/#writing-options) for the full list of writing options. +[^8]: See ["Writing Files"](/docs/api/write-options#writing-options) for the full list of writing options. [^9]: See ["Creating a DataFrame"](https://danfo.jsdata.org/api-reference/dataframe/creating-a-dataframe) in the DanfoJS documentation. [^10]: See [`sheet_to_json` in "Utilities"](/docs/api/utilities/array#array-output) [^11]: See ["danfo.toJSON"](https://danfo.jsdata.org/api-reference/input-output/danfo.to_json) in the DanfoJS documentation. diff --git a/docz/docs/03-demos/01-math/11-tensorflow.md b/docz/docs/03-demos/01-math/11-tensorflow.md index 6d1e4a0..c7ba37e 100644 --- a/docz/docs/03-demos/01-math/11-tensorflow.md +++ b/docz/docs/03-demos/01-math/11-tensorflow.md @@ -22,8 +22,8 @@ results back to spreadsheets. - ["CSV Data Interchange"](#csv-data-interchange) uses SheetJS to process sheets and generate CSV data that TF.js can import. -- ["JSON Data Interchange"](#json-data-interchange) uses SheetJS to process - sheets and generate rows of objects that can be post-processed. +- ["JS Array Interchange"](#js-array-interchange) uses SheetJS to process sheets + and generate rows of objects that can be post-processed. :::info pass diff --git a/docz/docs/03-demos/01-math/index.md b/docz/docs/03-demos/01-math/index.md index 4e3e285..dec0e8d 100644 --- a/docz/docs/03-demos/01-math/index.md +++ b/docz/docs/03-demos/01-math/index.md @@ -219,7 +219,9 @@ const petal_length = Float64Array.from(aoa.map(row => row[C]).slice(1)); Some datasets are stored in tables where each row represents a variable and each column represents an observation: -
JavaScriptSpreadsheet
+ + +
JavaScriptSpreadsheet
```js var aoa = [ @@ -332,7 +334,9 @@ function SheetJSeriesToRows() { return (