--- title: Illuminating Data with Lume sidebar_label: Lume description: Make static websites from spreadsheets using Lume. Seamlessly integrate data into your website using SheetJS. Illuminate data without leaving the comfort of Excel. pagination_prev: demos/net/index pagination_next: demos/mobile/index sidebar_custom_props: type: native --- [Lume](https://lume.land/) is a lightweight unopinionated static site generator. It has a rich ecosystem of JavaScript-powered plugins[^1] [SheetJS](https://sheetjs.com) is a JavaScript library for reading and writing data from spreadsheets. This demo uses Lume and SheetJS (through the official "Sheets" plugin) to pull data from a spreadsheet and display the content in an HTML table. The ["Complete Example"](#complete-example) section includes a complete website powered by an XLSX spreadsheet. ## Integration Details The official "Sheets" plugin[^2] uses SheetJS to load data from spreadsheets. Under the hood, the plugin uses the SheetJS `read`[^3] method to parse files and the `sheet_to_json`[^4] method to generate arrays of objects. Lume supports refreshing data during development. The generated static sites include the raw data without referencing the underlying spreadsheet files. ### Installation The `sheets` plugin can be imported and invoked in `_config.ts`: ```ts title="_config.ts" import lume from "lume/mod.ts"; // highlight-next-line import sheets from "lume/plugins/sheets.ts"; const site = lume(); // highlight-next-line site.use(sheets()); export default site; ``` :::info pass The lines are automatically added if `sheets` plugin is enabled during setup. ::: ### Usage Spreadsheet files added in the `_data` subdirectory are accessible from template files using the name stem. For example, [`pres.xlsx`](https://sheetjs.com/pres.xlsx) can be accessed using the variable `pres` in a template. #### Single-Sheet Workbooks When a workbook has one worksheet, the data is an array of row objects: ```liquid title="single.njk" {% for row in pres %} {% endfor %}
NameIndex
{{ row.Name }} {{ row.Index }}
``` #### Multi-Sheet Workbooks _Reading the First Worksheet_ The `sheets` plugin accepts an options argument. If the `sheets` property is set to `"first"`, then the plugin will expose row objects for the first sheet: ```ts title="_config.ts" // the first sheet of each file will be parsed and converted to row objects site.use(sheets({ sheets: "first" })); ``` _Reading all Worksheets_ The default behavior, when workbooks have multiple sheets, is to present objects whose keys are worksheet names and whose values are arrays of row objects. For example, if `pres.xlsx` had a sheet named `"Presidents"` and another sheet named `"VicePresidents"`, then the following snippet would print data from the `"Presidents"` sheet: ```liquid title="multi.njk" {% for row in pres["Presidents"] %} {% endfor %}
NameIndex
{{ row.Name }} {{ row.Index }}
``` #### File Formats As explained in the official plugin documentation[^5], the loader loads XLSX. NUMBERS, and CSV files. Other extensions can be added through the `extensions` property in the argument to the `sheets` plugin: ```ts site.use(sheets({ // highlight-next-line extensions: [".xlsx", ".xlsb", ".xls"] })); ``` ## Complete Example :::note This was tested against `lume v1.17.5` on 2023 June 25. This example uses the Nunjucks template format. Lume plugins support additional template formats, including Markdown and JSX. ::: ### Initial Setup 0) Install Deno[^6] 1) Create a stock site: ```bash mkdir -p sheetjs-lume cd sheetjs-lume deno run -Ar https://deno.land/x/lume/init.ts ``` When prompted, enter the following options: - `Choose the configuration file format`: select `_config.ts` - `Do you want to install some plugins now?`: select `Yes` - `Select the plugins to install`: scroll down, select `sheets`, and submit The project will be configured and modules will be installed. 2) Download and place in a `_data` folder: ```bash mkdir -p _data curl -L -o _data/pres.xlsx https://sheetjs.com/pres.xlsx ``` 3) Create a `index.njk` file that references the file: ```liquid title="index.njk"

Presidents

{% for row in pres %} {% endfor %}
NameIndex
{{ row.Name }} {{ row.Index }}
``` Since the file name is `pres.xlsx`, the parameter name is `pres`: ### Live Refresh 4) Run the development server: ```bash deno task serve --port 7262 ``` To verify it works, access `http://localhost:7262` from your web browser. The page will show the contents of the spreadsheet. 5) While the server is still running, open `_data/pres.xlsx` in a spreadsheet editor and add a new row at the bottom of the sheet. The page will refresh and show the new contents. ### Static Site 6) Stop the server (press `CTRL+C` in the terminal window) and run ```bash deno task lume ``` This will create a static site in the `_site` folder 7) Test the generated site by running ```bash npx http-server _site ``` The program will display a URL (typically `http://localhost:8080`). Accessing the page will show the contents of the spreadsheet. View the page source and confirm that the page only includes an HTML table. No scripts are included in this page. This site is self-contained and ready for deployment! [^1]: See ["Plugins"](https://lume.land/plugins/?status=all) in the Lume documentation [^2]: See ["Sheets"](https://lume.land/plugins/sheets/) in the Lume documentation [^3]: See [`read` in "Reading Files"](/docs/api/parse-options) [^4]: See [`sheet_to_json` in "Utilities"](/docs/api/utilities/array#array-output) [^5]: See ["Formats"](https://lume.land/plugins/sheets/#formats) in the Lume documentation [^6]: See ["Installation"](https://deno.com/manual/getting_started/installation) in the Deno documentation