reviewer

README

reviewer

reviewer is a spec-to-readable HTML compiler and review server.

Features

• Compiling Markdown to styled HTML documents
• Interactive local review server
• Gutter commenting on specific block elements
• Inline comment editing (with keyboard accessibility) and deletion before submission

Synopsis

$ reviewer build <input.md> -o <output.html>
$ reviewer serve <input.md> -p <port>

Installation

Using Homebrew:

$ brew install handlename/tap/reviewer

Or using go install:

$ go install github.com/handlename/reviewer/cmd/reviewer@latest

License

MIT

Author

@handlename

Documentation

Index

• Constants
• func InitLogger(level string)
• func RenderSpec(mdContent []byte) ([]byte, error)
• func StartReviewServer(ctx context.Context, htmlContent []byte, inputPath string, port int, ...) error
• type App
  • func New() *App
  • func (a *App) Run(ctx context.Context) error
• type Comment
• type SpecMetadata

Constants

const Version = "0.0.3"

Functions

func InitLogger

func InitLogger(level string)

func RenderSpec

func RenderSpec(mdContent []byte) ([]byte, error)

RenderSpec compiles markdown to fully designed interactive HTML

func StartReviewServer

func StartReviewServer(ctx context.Context, htmlContent []byte, inputPath string, port int, noOpen bool, readyChan chan<- string) error

StartReviewServer serves the compiled HTML spec, opens browser, and captures feedback. It accepts an optional readyChan, which receives the running server's URL once the port is bound.

Types

type App

type App struct{}

func New

func New() *App

func (*App) Run

func (a *App) Run(ctx context.Context) error

type Comment

type Comment struct {
	Text      string `json:"text"`
	Timestamp string `json:"timestamp"`
	Anchor    string `json:"anchor,omitempty"`  // Element selector ID/anchor
	Context   string `json:"context,omitempty"` // Preview text context of the commented element
}

Comment defines the unified structure for feedback comments.

type SpecMetadata

type SpecMetadata struct {
	Title   string
	Version string
	Date    string
	Body    string
}