Feature Overview

Created Thursday November 10, 2022

This document is a ‘kitchen sink’ overview of features supported by NotebookWebsiteTools notebooks.

Wolfram Cells

Input and Output Cells

Images:

Textual Cells

This is a Text cell.

This is an Item cell.
This is an ItemParagraph cell.
This is a Subitem cell.
This is an SubitemParagraph cell.
This is a Subsubitem cell.
This is an SubsubitemParagraph cell.
This is an ItemNumbered cell.
This is a SubitemNumbered cell.
This is a SubsubitemNumbered cell.
This is another SubsubitemNumbered cell.
This is another SubitemNumbered cell.

Program Cells 

fn foo() {
    println!("This is a function!");
}

Special Cells

Literal HTML

Cells with the style "ConnorGray/LiteralHTML" will appear verbatim in the built page.

This is an HTML literal cell.

Computed HTML

Cells with the style "ConnorGray/ComputedHTML" will be evaluated at the time the notebook is being converted into HTML.

The evaluation result must be an XMLElement expression, which will be converted into HTML that will appear in the built page.

Last built: Sunday, 24 March 2024, 9:36pm

Syntax Highlighting

Cells with the style "ConnorGray/HighlightSyntax" will display with syntax highlighting in the built page.

fn foo() {
    println!("This is a function!");
}
Options

The following options can be used to customize the appearance of "ConnorGray/HighlightSyntax" cells.

"Syntax" → "name"
"Theme" → "name"
"LineNumbering" → True | False

Special Links

Special links are a stylized way to call out links to common external destinations.

This ConnorGray/NotebookWebsiteTools is an inline GitHub link.
This ConnorGray/Organizer is an inline paclet link.

Generated Content

NotebookWebsiteTools provides convenience functions for generating common website navigation and other elements based on notebook website source content.

Table Of Contents

TableOfContentsHtml[] returns a formatted table of contents based on the cell groups present in the content source notebook.

Pages Summary List

PagesSummaryListHtml[] returns a formatted list of notebook website pages, with a summary derived from their initial textual content.

Visual Site Map

VisualSiteMapHtml[] returns a hierarchical listing of all of the documents on this website.

Link Dashboard

LinkDashboard[links] returns a link “dashboard”, useful as a display of quickly accessible links. For example, consider configuring your browser's default 'New Tab' content to be a webpage with a link dashboard.