README
¶
notebook
A Notebook is a simple Go package to easily generate HTML file that look likes a 'notebook'.
The generated notebook has some level of configuration but it is mainly opinionated, and comes with sensible defaults. The objective is to allow the user to focus on the simulation code, and to generate a notebook to visualize the results fairly easily.
Like markdown, or static site generator, the focus in on the balance between content (here simulation code) and good enough rendering.
third party packages (not linked to avoid dependencies) can add specialized Cells to the notebook based on simulation primitives.
- gonum extension to display any gonum chart
- markdown extension to easily insert markdown and math in a cell.
- table extension to ease the rendering of an html table.
- timeserie extension to display timeseries in tables
- vector extension to render vector of floats, or numbers in a table
- ...
Documentation
¶
Index ¶
- Constants
- type Notebook
- func (nb *Notebook) AddContent(title string, content string)
- func (nb *Notebook) AddHeader(id string, content string)
- func (nb *Notebook) Close() error
- func (nb *Notebook) Print(a ...any) (n int, err error)
- func (nb *Notebook) Printf(format string, a ...any) (n int, err error)
- func (nb *Notebook) Println(a ...any) (n int, err error)
- func (nb *Notebook) Render(w io.Writer) error
Constants ¶
const HeaderCellStyle = "cell-style" // ID to set a style header to style cells. A default value is provided.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Notebook ¶
type Notebook struct {
Title string // The notebook title.
Output string // A filename to save the Notebook to.
// contains filtered or unexported fields
}
Notebook is a struct to receive all the contents of a notebook in memory.
func New ¶
func New() *Notebook
New creates a new Notebook.
Output filename is initialized to be the os.Arg[0] +'.html'.
func (*Notebook) AddContent ¶
AddContent appends html content into a new Cell.
func (*Notebook) AddHeader ¶
AddHeader appends a header statement, once per ID. Calling AddHeader with the same ID will overwrite the existing value.
Source Files