diff --git a/docz/docs/02-installation/01-standalone.mdx b/docz/docs/02-getting-started/01-installation/01-standalone.mdx similarity index 100% rename from docz/docs/02-installation/01-standalone.mdx rename to docz/docs/02-getting-started/01-installation/01-standalone.mdx diff --git a/docz/docs/02-installation/02-frameworks.md b/docz/docs/02-getting-started/01-installation/02-frameworks.md similarity index 96% rename from docz/docs/02-installation/02-frameworks.md rename to docz/docs/02-getting-started/01-installation/02-frameworks.md index 0810138..e5b7f6e 100644 --- a/docz/docs/02-installation/02-frameworks.md +++ b/docz/docs/02-getting-started/01-installation/02-frameworks.md @@ -39,6 +39,9 @@ Once installed, the library can be imported under the name `xlsx`: import { read, writeFileXLSX } from "xlsx"; ``` +The ["Bundlers" demo](../../demos/bundler) includes examples for specific +bundler tools. + :::warning Older releases are technically available on the public npm registry as `xlsx`, diff --git a/docz/docs/02-installation/03-deno.md b/docz/docs/02-getting-started/01-installation/03-deno.md similarity index 100% rename from docz/docs/02-installation/03-deno.md rename to docz/docs/02-getting-started/01-installation/03-deno.md diff --git a/docz/docs/02-installation/04-nodejs.md b/docz/docs/02-getting-started/01-installation/04-nodejs.md similarity index 100% rename from docz/docs/02-installation/04-nodejs.md rename to docz/docs/02-getting-started/01-installation/04-nodejs.md diff --git a/docz/docs/02-installation/05-extendscript.md b/docz/docs/02-getting-started/01-installation/05-extendscript.md similarity index 100% rename from docz/docs/02-installation/05-extendscript.md rename to docz/docs/02-getting-started/01-installation/05-extendscript.md diff --git a/docz/docs/02-installation/06-amd.md b/docz/docs/02-getting-started/01-installation/06-amd.md similarity index 96% rename from docz/docs/02-installation/06-amd.md rename to docz/docs/02-getting-started/01-installation/06-amd.md index 6435771..7e56716 100644 --- a/docz/docs/02-installation/06-amd.md +++ b/docz/docs/02-getting-started/01-installation/06-amd.md @@ -34,7 +34,7 @@ define(['N/file', './xlsx.full.min'], function(file, XLSX) { }) ``` -As explained in the [NetSuite demo](../getting-started/demos/netsuite), module +As explained in the [NetSuite demo](../../demos/netsuite), module aliases are created in config files referenced via `@NAmdConfig` comments. ## SAP UI5 diff --git a/docz/docs/02-installation/07-bun.md b/docz/docs/02-getting-started/01-installation/07-bun.md similarity index 100% rename from docz/docs/02-installation/07-bun.md rename to docz/docs/02-getting-started/01-installation/07-bun.md diff --git a/docz/docs/02-installation/_category_.json b/docz/docs/02-getting-started/01-installation/_category_.json similarity index 65% rename from docz/docs/02-installation/_category_.json rename to docz/docs/02-getting-started/01-installation/_category_.json index e111289..eab47a2 100644 --- a/docz/docs/02-installation/_category_.json +++ b/docz/docs/02-getting-started/01-installation/_category_.json @@ -1,4 +1,4 @@ { "label": "Installation", - "position": 2 + "position": 1 } diff --git a/docz/docs/03-example.mdx b/docz/docs/02-getting-started/02-example.mdx similarity index 99% rename from docz/docs/03-example.mdx rename to docz/docs/02-getting-started/02-example.mdx index 9211986..e3c307c 100644 --- a/docz/docs/03-example.mdx +++ b/docz/docs/02-getting-started/02-example.mdx @@ -1,8 +1,8 @@ --- -sidebar_position: 3 +sidebar_position: 2 --- -# Complete Example +# Tutorial SheetJS presents a simple JS interface that works with "Array of Arrays" and "Array of JS Objects". The API functions are building blocks that should be diff --git a/docz/docs/04-getting-started/01-roadmap.md b/docz/docs/02-getting-started/03-roadmap.md similarity index 99% rename from docz/docs/04-getting-started/01-roadmap.md rename to docz/docs/02-getting-started/03-roadmap.md index e98cae2..e4605bf 100644 --- a/docz/docs/04-getting-started/01-roadmap.md +++ b/docz/docs/02-getting-started/03-roadmap.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 3 --- # Roadmap diff --git a/docz/docs/04-getting-started/02-zen.md b/docz/docs/02-getting-started/04-zen.md similarity index 97% rename from docz/docs/04-getting-started/02-zen.md rename to docz/docs/02-getting-started/04-zen.md index 5d99fcb..40bc92c 100644 --- a/docz/docs/04-getting-started/02-zen.md +++ b/docz/docs/02-getting-started/04-zen.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 4 hide_table_of_contents: true --- @@ -20,7 +20,7 @@ representation of the core concepts of a workbook. The various functions in the library 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 [Complete example](../03-example.mdx) +a worksheet to/from an Array of Arrays. The [Complete example](./02-example.mdx) 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/04-getting-started/_category_.json b/docz/docs/02-getting-started/_category_.json similarity index 77% rename from docz/docs/04-getting-started/_category_.json rename to docz/docs/02-getting-started/_category_.json index 8103e63..2ce013d 100644 --- a/docz/docs/04-getting-started/_category_.json +++ b/docz/docs/02-getting-started/_category_.json @@ -1,5 +1,5 @@ { "label": "Getting Started", "collapsed": false, - "position": 4 + "position": 2 } diff --git a/docz/docs/img/final.png b/docz/docs/02-getting-started/img/final.png similarity index 100% rename from docz/docs/img/final.png rename to docz/docs/02-getting-started/img/final.png diff --git a/docz/docs/img/rough.png b/docz/docs/02-getting-started/img/rough.png similarity index 100% rename from docz/docs/img/rough.png rename to docz/docs/02-getting-started/img/rough.png diff --git a/docz/docs/02-getting-started/index.md b/docz/docs/02-getting-started/index.md new file mode 100644 index 0000000..7e14274 --- /dev/null +++ b/docz/docs/02-getting-started/index.md @@ -0,0 +1,29 @@ +--- +hide_table_of_contents: true +--- + +# Getting Started + +["Tutorial"](./02-example.mdx) is a live example that covers general data +munging and data export to spreadsheets. + +## Installation + +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + is the primary software distribution site. Please +read the installation instructions for your use case: + + + diff --git a/docz/docs/02-installation/index.md b/docz/docs/02-installation/index.md deleted file mode 100644 index 56f86e0..0000000 --- a/docz/docs/02-installation/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -hide_table_of_contents: true ---- - -# Installation - -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - is the primary software distribution site. Please -read the installation instructions for your use case: - - \ No newline at end of file diff --git a/docz/docs/04-getting-started/03-demos/01-salesforce.md b/docz/docs/03-demos/01-salesforce.md similarity index 99% rename from docz/docs/04-getting-started/03-demos/01-salesforce.md rename to docz/docs/03-demos/01-salesforce.md index 58935fa..676ff56 100644 --- a/docz/docs/04-getting-started/03-demos/01-salesforce.md +++ b/docz/docs/03-demos/01-salesforce.md @@ -107,7 +107,7 @@ should see a page like ## Adding the Standalone Script -The [standalone script](../../installation/standalone) can be downloaded and +The [standalone script](../getting-started/installation/standalone) can be downloaded and added as a static resource. Due to Salesforce naming restrictions, it will have to be renamed to `sheetjs.js` when adding the static resource. diff --git a/docz/docs/04-getting-started/03-demos/02-extendscript.md b/docz/docs/03-demos/02-extendscript.md similarity index 95% rename from docz/docs/04-getting-started/03-demos/02-extendscript.md rename to docz/docs/03-demos/02-extendscript.md index 9bedc6a..ec94a84 100644 --- a/docz/docs/04-getting-started/03-demos/02-extendscript.md +++ b/docz/docs/03-demos/02-extendscript.md @@ -23,7 +23,7 @@ extension development is assumed. ## ExtendScript Scripts -[Installation is straightforward:](../../installation/extendscript) download a +[Installation is straightforward:](../getting-started/installation/extendscript) download a script and move it to your project directory. ### Reading Files @@ -179,12 +179,12 @@ and place in the scripts directory. For CS6 Windows 10 the path is typically ## CEP -[The standalone scripts](../../installation/standalone) can be added to CEP +[The standalone scripts](../getting-started/installation/standalone) can be added to CEP extension HTML ## UXP UXP officially recommends `require` and NodeJS Modules for third party support. -[Use the "Frameworks" instructions to download.](../../installation/frameworks) +[Use the "Frameworks" instructions to download.](../getting-started/installation/frameworks) diff --git a/docz/docs/04-getting-started/03-demos/03-database.md b/docz/docs/03-demos/03-database.md similarity index 100% rename from docz/docs/04-getting-started/03-demos/03-database.md rename to docz/docs/03-demos/03-database.md diff --git a/docz/docs/04-getting-started/03-demos/04-netsuite.md b/docz/docs/03-demos/04-netsuite.md similarity index 100% rename from docz/docs/04-getting-started/03-demos/04-netsuite.md rename to docz/docs/03-demos/04-netsuite.md diff --git a/docz/docs/04-getting-started/03-demos/05-gsheet.md b/docz/docs/03-demos/05-gsheet.md similarity index 100% rename from docz/docs/04-getting-started/03-demos/05-gsheet.md rename to docz/docs/03-demos/05-gsheet.md diff --git a/docz/docs/04-getting-started/03-demos/06-network.mdx b/docz/docs/03-demos/06-network.mdx similarity index 99% rename from docz/docs/04-getting-started/03-demos/06-network.mdx rename to docz/docs/03-demos/06-network.mdx index 16fdca6..55517bc 100644 --- a/docz/docs/04-getting-started/03-demos/06-network.mdx +++ b/docz/docs/03-demos/06-network.mdx @@ -3,11 +3,14 @@ sidebar_position: 6 title: HTTP Network Requests --- +# XHR and fetch + + `XMLHttpRequest` and `fetch` browser APIs enable binary data transfer between web browser clients and web servers. Since this library works in web browsers, server conversion work can be offloaded to the client! This demo shows a few @@ -384,7 +387,7 @@ function SheetJSAxiosUL() { -### superagent Wrapper Library +#### superagent The `superagent` library usage mirrors XHR: diff --git a/docz/docs/04-getting-started/03-demos/07-headless.md b/docz/docs/03-demos/07-headless.md similarity index 98% rename from docz/docs/04-getting-started/03-demos/07-headless.md rename to docz/docs/03-demos/07-headless.md index cc4725a..61c0446 100644 --- a/docz/docs/04-getting-started/03-demos/07-headless.md +++ b/docz/docs/03-demos/07-headless.md @@ -8,7 +8,7 @@ Headless automation involves controlling "headless browsers" to access websites and submit or download data. It is also possible to automate browsers using custom browser extensions. -The [SheetJS standalone script](../../installation/standalone) can be added to +The [SheetJS standalone script](../getting-started/installation/standalone) can be added to any website by inserting a `SCRIPT` tag. Headless browsers usually provide utility functions for running custom snippets in the browser and passing data back to the automation script. diff --git a/docz/docs/04-getting-started/03-demos/08-ml.mdx b/docz/docs/03-demos/08-ml.mdx similarity index 100% rename from docz/docs/04-getting-started/03-demos/08-ml.mdx rename to docz/docs/03-demos/08-ml.mdx diff --git a/docz/docs/04-getting-started/03-demos/09-bundler.md b/docz/docs/03-demos/09-bundler.md similarity index 99% rename from docz/docs/04-getting-started/03-demos/09-bundler.md rename to docz/docs/03-demos/09-bundler.md index 42b05f1..0ff7810 100644 --- a/docz/docs/04-getting-started/03-demos/09-bundler.md +++ b/docz/docs/03-demos/09-bundler.md @@ -30,7 +30,7 @@ var XLSX = require("xlsx"); // ... use XLSX ... ``` -[After installing the module](../../installation/nodejs), bundling is easy: +[After installing the module](../getting-started/installation/nodejs), bundling is easy: ```bash browserify app.js > browserify.js @@ -351,7 +351,7 @@ Parcel version 1.5.0 or later.
Complete Example (click to show) -This demo follows the [Presidents Example](../../example). +This demo follows the [Presidents Example](../getting-started/example). 1) Save the following to `index.html`: @@ -433,7 +433,7 @@ click the "Click to Export!" button to generate a file. ## RequireJS -[Standalone scripts](../../installation/standalone) comply with AMD `define` +[Standalone scripts](../getting-started/installation/standalone) comply with AMD `define` semantics, enabling use in RequireJS out of the box. To enable use of the alias `xlsx`, the RequireJS config should set an alias in @@ -1067,7 +1067,7 @@ Webpack bundled the CommonJS build in older versions of the library. Version `0.18.1` changed the NodeJS module package so that Webpack uses the ESM build. The ESM build does not include the codepage support library for XLS reading. -[As described in the installation instructions](../../installation/frameworks), +[As described in the installation instructions](../getting-started/installation/frameworks), the codepage dependency should be imported explicitly: ```js diff --git a/docz/docs/04-getting-started/03-demos/10-excel.md b/docz/docs/03-demos/10-excel.md similarity index 94% rename from docz/docs/04-getting-started/03-demos/10-excel.md rename to docz/docs/03-demos/10-excel.md index 0598f91..77f30d5 100644 --- a/docz/docs/04-getting-started/03-demos/10-excel.md +++ b/docz/docs/03-demos/10-excel.md @@ -120,7 +120,7 @@ This indicates that the SheetJS library has been loaded. ## Dynamic Arrays and SheetJS Array of Arrays -The [`sheet_to_json`](../../api/utilities#json) helper function can generate +The [`sheet_to_json`](../api/utilities#json) helper function can generate arrays of arrays of values based on the worksheet data. Excel custom functions transparently treat these as Dynamic Arrays. @@ -160,7 +160,7 @@ var wb = XLSX.read(ab); // parse workbook For the purposes of this demo, a Base64-encoded file will be used. The workaround involves fetching that Base64 file, getting the text, and parsing -with the [`base64` type:](../../api/parse-options#input-type) +with the [`base64` type:](../api/parse-options#input-type) ```js async function extern() { diff --git a/docz/docs/04-getting-started/03-demos/11-nosql.md b/docz/docs/03-demos/11-nosql.md similarity index 100% rename from docz/docs/04-getting-started/03-demos/11-nosql.md rename to docz/docs/03-demos/11-nosql.md diff --git a/docz/docs/04-getting-started/03-demos/12-legacy.md b/docz/docs/03-demos/12-legacy.md similarity index 99% rename from docz/docs/04-getting-started/03-demos/12-legacy.md rename to docz/docs/03-demos/12-legacy.md index 5b8473a..80150ea 100644 --- a/docz/docs/04-getting-started/03-demos/12-legacy.md +++ b/docz/docs/03-demos/12-legacy.md @@ -14,7 +14,7 @@ SheetJS libraries strive to maintain broad browser and JS engine compatibility. ## Integration -The ["Standalone Browser Scripts"](../../installation/standalone) section has +The ["Standalone Browser Scripts"](../getting-started/installation/standalone) section has instructions for obtaining or referencing the standalone scripts. These are designed to be referenced with ` +``` + +The browser should refresh to show the contents of the spreadsheet. If it does +not, hit Refresh manually or open a new browser window. + +![Nuxt Demo end of step 5](pathname:///nuxt/nuxt5.png) + +6) To verify that hot loading works, open `pres.xlsx` from the `content` folder +in Excel. Add a new row to the bottom and save the file: + +![Adding a new line to `pres.xlsx`](pathname:///nuxt/nuxl6.png) + +The dev server terminal should show a line like: + +``` +ℹ Updated ./content/pres.xlsx @nuxt/content 05:43:37 +``` + +The page should automatically refresh with the new content: + +![Nuxt Demo end of step 6](pathname:///nuxt/nuxt6.png) + +7) Stop the dev server (hit `CTRL+C` in the terminal window) and run + +```bash +npm run generate +``` + +This will create a static site in the `dist` folder, which can be served with: + +```bash +npx http-server dist +``` + +Accessing the page http://localhost:8080 will show the page contents. Verifying +the static nature is trivial: make another change in Excel and save. The page +will not change. + +
diff --git a/docz/docs/04-getting-started/03-demos/_category_.json b/docz/docs/03-demos/_category_.json similarity index 52% rename from docz/docs/04-getting-started/03-demos/_category_.json rename to docz/docs/03-demos/_category_.json index 29564b6..aba1258 100644 --- a/docz/docs/04-getting-started/03-demos/_category_.json +++ b/docz/docs/03-demos/_category_.json @@ -1,4 +1,4 @@ { "label": "Demos", - "position": 3 + "position": 4 } \ No newline at end of file diff --git a/docz/docs/04-getting-started/03-demos/index.md b/docz/docs/03-demos/index.md similarity index 97% rename from docz/docs/04-getting-started/03-demos/index.md rename to docz/docs/03-demos/index.md index f89e044..d5649e4 100644 --- a/docz/docs/04-getting-started/03-demos/index.md +++ b/docz/docs/03-demos/index.md @@ -37,6 +37,7 @@ The demo projects include small runnable examples and short explainers. - [`Command-Line Tools`](./cli) - [`iOS / Android Mobile Applications`](./mobile) - [`NodeJS Server-Side Processing`](https://github.com/SheetJS/SheetJS/tree/master/demos/server/) +- [`Content Management and Static Sites`](./content) - [`Electron`](./desktop#electron) - [`NW.js`](./desktop#nwjs) - [`Chrome / Chromium Extension`](./chromium) diff --git a/docz/docs/06-solutions/01-input.md b/docz/docs/06-solutions/01-input.md index 2511085..ab99426 100644 --- a/docz/docs/06-solutions/01-input.md +++ b/docz/docs/06-solutions/01-input.md @@ -47,7 +47,7 @@ Deno scripts must be invoked with `--allow-read` to read from the filesystem. Here are a few common scenarios (click on each subtitle to see the code). -The [demos](../getting-started/demos) cover special deployments in more detail. +The [demos](../demos) cover special deployments in more detail. ### Example: Local File @@ -90,7 +90,7 @@ var XLSX = require("xlsx"); var workbook = XLSX.readFile(path); ``` -Electron APIs have changed over time. The [`electron` demo](../getting-started/demos/desktop#electron) +Electron APIs have changed over time. The [`electron` demo](../demos/desktop#electron) shows a complete example and details the required version-specific settings. @@ -195,7 +195,7 @@ var thisFile = File.openDialog("Select a spreadsheet"); var workbook = XLSX.readFile(thisFile.absoluteURI); ``` -The [`extendscript` demo](../getting-started/demos/extendscript) includes a more complex example. +The [`extendscript` demo](../demos/extendscript) includes a more complex example. @@ -498,7 +498,7 @@ req.onload = function(e) { req.send(); ``` -The [`xhr` demo](../getting-started/demos/network) includes a longer discussion and more examples. +The [`xhr` demo](../demos/network) includes a longer discussion and more examples. shows fallback approaches for IE6+. @@ -551,7 +551,7 @@ const url = "http://oss.sheetjs.com/test_files/formula_stress_test.xlsx"; -Bun has native support for `fetch`. Using the [NodeJS package](../installation/nodejs): +Bun has native support for `fetch`. Using the [NodeJS package](../getting-started/installation/nodejs): ```js import * as XLSX from 'xlsx/xlsx.mjs'; @@ -797,8 +797,8 @@ the optional `opts` argument in more detail. #### Examples -["Complete Example"](../example) contains a detailed example "Get Data -from a JSON Endpoint and Generate a Workbook" +["Complete Example"](../getting-started/example) contains a detailed example +"Get Data from a JSON Endpoint and Generate a Workbook" [`x-spreadsheet`](https://github.com/myliang/x-spreadsheet) is an interactive data grid for previewing and modifying structured data in the web browser. The @@ -806,7 +806,7 @@ data grid for previewing and modifying structured data in the web browser. The includes a sample script with the `xtos` function for converting from x-spreadsheet to a workbook. Live Demo: -["Typed Arrays and ML"](../getting-started/demos/ml) covers strategies for +["Typed Arrays and ML"](../demos/ml) covers strategies for creating worksheets from ML library exports (datasets stored in Typed Arrays).
@@ -850,7 +850,7 @@ is missing or no options are specified, the default name `Sheet1` is used. #### Examples -The [Headless Demo](../getting-started/demos/headless) includes examples of +The [Headless Demo](../demos/headless) includes examples of server-side spreadsheet generation from HTML TABLE elements using headless Chromium ("Puppeteer") and other browsers ("Playwright") diff --git a/docz/docs/06-solutions/05-output.md b/docz/docs/06-solutions/05-output.md index 0b0d09f..4abed6d 100644 --- a/docz/docs/06-solutions/05-output.md +++ b/docz/docs/06-solutions/05-output.md @@ -64,7 +64,7 @@ files. The APIs do not generally provide feedback on whether files were created. Here are a few common scenarios (click on each subtitle to see the code). -The [demos](../getting-started/demos) cover special deployments in more detail. +The [demos](../demos) cover special deployments in more detail. ### Example: Local File @@ -235,7 +235,7 @@ var XLSX = require("xlsx"); XLSX.writeFile(workbook, "out.xlsb"); ``` -Electron APIs have changed over time. The [`electron` demo](../getting-started/demos/desktop#electron) +Electron APIs have changed over time. The [`electron` demo](../demos/desktop#electron) shows a complete example and details the required version-specific settings. @@ -313,12 +313,12 @@ var thisFile = File.saveDialog("Select an output file", "*.xlsx;*.xls"); XLSX.writeFile(workbook, thisFile.absoluteURI); ``` -The [`extendscript` demo](../getting-started/demos/extendscript) includes a more complex example. +The [`extendscript` demo](../demos/extendscript) includes a more complex example. -The [`headless` demo](../getting-started/demos/headless) includes complete +The [`headless` demo](../demos/headless) includes complete examples of converting HTML TABLE elements to XLSB workbooks using Puppeteer and other headless automation tools. @@ -503,7 +503,7 @@ is to adjust the server process or Lambda function to accept Base64 strings. ::: -A complete example using XHR is [included in the XHR demo](../getting-started/demos/network), along +A complete example using XHR is [included in the XHR demo](../demos/network), along with examples for fetch and wrapper libraries. This example assumes the server can handle Base64-encoded files (see the demo for a basic nodejs server): @@ -658,7 +658,7 @@ simple VueJS 3 data table. It is featured in the ### Example: Data Loading -["Typed Arrays and ML"](../getting-started/demos/ml) covers strategies for +["Typed Arrays and ML"](../demos/ml) covers strategies for generating typed arrays and tensors from worksheet data.
diff --git a/docz/docs/06-solutions/_category_.json b/docz/docs/06-solutions/_category_.json index 9cbca82..9c8c72b 100644 --- a/docz/docs/06-solutions/_category_.json +++ b/docz/docs/06-solutions/_category_.json @@ -1,5 +1,5 @@ { "label": "Common Use Cases", - "collapsed": false, + "collapsed": true, "position": 6 } diff --git a/docz/docs/07-csf/_category_.json b/docz/docs/07-csf/_category_.json index fc2c79c..b26ba68 100644 --- a/docz/docs/07-csf/_category_.json +++ b/docz/docs/07-csf/_category_.json @@ -1,4 +1,4 @@ { - "label": "CSF Object Model", + "label": "SheetJS Data Model", "position": 7 } diff --git a/docz/docs/08-api/_category_.json b/docz/docs/08-api/_category_.json index 2c5d9f1..bb46120 100644 --- a/docz/docs/08-api/_category_.json +++ b/docz/docs/08-api/_category_.json @@ -1,4 +1,4 @@ { - "label": "API Functions", + "label": "API Reference", "position": 8 } diff --git a/docz/docs/05-interface.md b/docz/docs/08-api/index.md similarity index 89% rename from docz/docs/05-interface.md rename to docz/docs/08-api/index.md index 84ec4ad..e2cfa0d 100644 --- a/docz/docs/05-interface.md +++ b/docz/docs/08-api/index.md @@ -1,8 +1,9 @@ --- sidebar_position: 5 +title: API Reference --- -# Interface Summary +## Interface Summary `XLSX` is the exposed variable in the browser and the exported node variable @@ -18,7 +19,7 @@ sidebar_position: 5 `XLSX.readFile(filename, read_opts)` attempts to read `filename` and parse. -Parse options are described in the [Parsing Options](./api/parse-options) section. +Parse options are described in the [Parsing Options](./parse-options) section. ## Writing functions @@ -34,13 +35,13 @@ In browser-based environments, it will attempt to force a client-side download. `XLSX.writeFileAsync(filename, wb, o, cb)` attempts to write `wb` to `filename`. If `o` is omitted, the writer will use the third argument as the callback. -Write options are described in the [Writing Options](./api/write-options) section. +Write options are described in the [Writing Options](./write-options) section. ## Utilities Utilities are available in the `XLSX.utils` object. -The following are described in [A1 Utilities](./csf/general#a1-utilities) +The following are described in [A1 Utilities](../csf/general#a1-utilities) **Cell and cell address manipulation:** @@ -49,7 +50,7 @@ The following are described in [A1 Utilities](./csf/general#a1-utilities) - `encode_cell / decode_cell` converts cell addresses. - `encode_range / decode_range` converts cell ranges. -The following are described in the [Utility Functions](./api/utilities): +The following are described in the [Utility Functions](./utilities): **Constructing:** diff --git a/docz/docs/index.md b/docz/docs/index.md index 72a407a..03e571e 100644 --- a/docz/docs/index.md +++ b/docz/docs/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 hide_table_of_contents: true +title: Overview --- # SheetJS CE diff --git a/docz/docusaurus.config.js b/docz/docusaurus.config.js index beb22a4..3117897 100644 --- a/docz/docusaurus.config.js +++ b/docz/docusaurus.config.js @@ -98,7 +98,7 @@ const config = { }, { label: 'Example', - to: '/docs/example', + to: '/docs/getting-started/example', }, ], }, diff --git a/docz/src/components/HomepageFeatures/index.js b/docz/src/components/HomepageFeatures/index.js index a1b1c36..04fe4dd 100644 --- a/docz/src/components/HomepageFeatures/index.js +++ b/docz/src/components/HomepageFeatures/index.js @@ -36,7 +36,7 @@ const FeatureList = [
+ to="/docs/getting-started/example"> Complete Example
@@ -55,7 +55,7 @@ const FeatureList = [
+ to="/docs/demos/"> Demo Projects
diff --git a/docz/static/knockout/knockout.html b/docz/static/knockout/knockout.html index 16fc1f8..611408d 100644 --- a/docz/static/knockout/knockout.html +++ b/docz/static/knockout/knockout.html @@ -17,7 +17,7 @@ The core library can be used as-is in KnockoutJS applications. The Community Edition README details some common use cases. -We also have some more public demos +We also have some more public demos This demo shows: - view model backed by an array of arrays diff --git a/docz/static/nuxt/nuxl6.png b/docz/static/nuxt/nuxl6.png new file mode 100644 index 0000000..35f15d9 Binary files /dev/null and b/docz/static/nuxt/nuxl6.png differ diff --git a/docz/static/nuxt/nuxt5.png b/docz/static/nuxt/nuxt5.png new file mode 100644 index 0000000..ad4336a Binary files /dev/null and b/docz/static/nuxt/nuxt5.png differ diff --git a/docz/static/nuxt/nuxt6.png b/docz/static/nuxt/nuxt6.png new file mode 100644 index 0000000..06ff608 Binary files /dev/null and b/docz/static/nuxt/nuxt6.png differ