SheetJS Community Edition Docs repo
Go to file
2024-04-11 13:44:06 -04:00
docz stata demos refresh 2024-04-11 13:44:06 -04:00
misc WPS 电子表格 2022-10-20 20:10:10 -04:00
tests graaljs 2024-03-24 04:06:44 -04:00
_headers content-type 2023-09-02 05:26:57 -04:00
.gitattributes excel javascript api 2022-05-30 22:53:56 -04:00
.gitignore math 2024-01-03 01:47:00 -05:00
.spelling eleventy 2023-05-07 09:58:36 -04:00
CNAME Create CNAME 2020-01-27 23:39:02 -05:00
formats.png WPS 电子表格 2022-10-20 20:10:10 -04:00
index.html 0.18.7 2022-05-11 17:03:03 -04:00
legend.png WPS 电子表格 2022-10-20 20:10:10 -04:00
Makefile chakra-linux 2023-07-06 03:21:41 -04:00
package.json chakra-linux 2023-07-06 03:21:41 -04:00 mdx cleanup in preparation for v2 2024-04-08 00:57:39 -04:00

SheetJS CE Docs

Hosted URL:


The site source code is in the docz folder. make builds the static site and moves the generated pages and scripts to the docs folder.

docz/version.js exports a version number for use in docs pages.

Build Commands

$ make init    # install dependencies
$ make         # build static site
$ make serve   # serve static site

$ make dev     # run dev server
$ make spell   # spell check (.spelling custom dictionary)
$ make graph   # build format graph and legend

Documentation Markup

The original documentation used GFM.

Pages currently use MDX v1.

MDX Notes (click to show)

Multi-line tags

Markdown and MDX v1 accept the following:

<details><summary><b>MDX Notes</b> (click to show)</summary>



This is no longer valid in MDX v2. The <summary> part must be separated:

  <summary><b>MDX Notes</b> (click to show)</summary>




Markdown and MDX v1 support shortlinks:

Scripts are available at <>

This is no longer valid in MDX v2. Autolinks should be used:

Scripts are available at

Engine Compatibility Tables

docz/src/data/engines.xls is an XLML workbook that controls the compatibility tables in The component script docz/src/data/engines.js parses the file and generates content.

Formats Graph

The formats graph and legend are written in the DOT language. Rebuilding the graphs will require Graphviz (brew install graphviz on macOS)

Live Demos is loaded on each page, making the XLSX variable available to live blocks.

Page-Specific Scripts

Imports do not work from live codeblocks!

Docusaurus does not have an official recommendation for this workflow.

Specific pages can load scripts using the head component:

  <script src=""></script>

Adding scripts through head is known to be brittle!

Live codeblocks that use external libraries in useEffect hooks should check before using variables. For example, the Dropbox live demo tests if Dropbox is defined before proceeding. If it is not defined, a message is displayed.

function SheetJSTestDropbox() {
  const [msg, setMsg] = React.useState("Dropbox is defined");

  React.useEffect(() => {
    if(typeof Dropbox == "undefined") return setMsg("Dropbox is not defined");
  }, []);
  return ( <b>{msg}</b> );

Other Notes

src/theme/Admonition was swizzled from 2.4.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 Liquid language. See Docusaurus issue 6872 for more details.