notebook

package
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package notebook generates a rich, shareable project notebook from a cloop plan. The notebook captures the full project story: goal, plan health, task list with status/priority/tags, per-task output excerpts from persisted artifacts, time estimates vs actuals, and a retrospective summary.

Two output formats are supported:

  • "md" / "markdown" — GitHub-flavoured Markdown
  • "html" — self-contained single-file HTML (inline CSS, no external dependencies) with collapsible sections per task

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Build

func Build(workDir string, s *state.ProjectState, format string) (string, error)

Build generates the notebook document for the project rooted at workDir. plan may be nil (in which case plan-specific sections are omitted). format must be "md", "markdown", or "html"; anything else defaults to "md".

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL