Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.95 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.95 KB

NotebookWebsiteTools

A static site generator based on Wolfram Notebooks.

Examples

feature-overview.nb (image) is a Wolfram Notebook that contains an overview of features supported by NotebookWebsiteTools.

feature-overview.html is the HTML rendered version of feature-overview.nb.

Building the Examples website

The ./Examples subdirectory of this repository is a website in the layout expected by NotebookWebsiteBuild[..].

To build the Examples website, first load NotebookWebsiteTools:

Needs["ConnorGray`NotebookWebsiteTools`"]

Then use NotebookWebsiteBuild to build:

NotebookWebsiteBuild["/path/to/NotebookWebsiteTools/Examples"]

The built website assets will be placed in the Examples/build directory.

Command-Line Interface

A command-line interface to NotebookWebsiteTools functionality is available via the unofficial wolfram-cli tool.

If wolfram-cli is available, and the NotebookWebsiteTools paclet is installed, then a notebook website can be built using:

$ wolfram-cli notebook-website build [WEBSITE_DIR]

Include documents with the Draft status flag:

$ wolfram-cli notebook-website build [WEBSITE_DIR] --drafts

Contributing

See Development.md for instructions on how to develop NotebookWebsiteTools.

Credits