internal

package
v0.10.0 Latest Latest
Warning

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

Go to latest
Published: May 17, 2026 License: MIT Imports: 38 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Open

func Open(url string) error

Types

type Article

type Article struct {
	Title       string
	Path        string
	Filename    string
	Active      bool
	IsDirectory bool
	Expanded    bool
	Children    []Article
}

type Parser

type Parser struct{}

func NewParser

func NewParser() *Parser

func (Parser) MdToHTML

func (m Parser) MdToHTML(input []byte) ([]byte, error)

func (Parser) Render

func (m Parser) Render(input []byte) (*RenderedDocument, error)

type RenderedDocument

type RenderedDocument struct {
	Content string
	TOC     []TOCEntry
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(host string, port int, boundingBox bool, browser bool, enableReload bool, parser *Parser) *Server

func NewServerWithOptions

func NewServerWithOptions(opts ServerOptions) *Server

func (*Server) Serve

func (s *Server) Serve(file string) error

type ServerOptions

type ServerOptions struct {
	Host         string
	Port         int
	BoundingBox  bool
	Browser      bool
	EnableReload bool
	StrictPort   bool
	Recursive    bool
	Parser       *Parser
}

type TOCEntry

type TOCEntry struct {
	Level int
	Text  string
	ID    string
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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