docs

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Aug 15, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateContent

func ValidateContent(content []byte, allowedCategories []string) error

Types

type Doc

type Doc struct {
	ID     string   `yaml:"id"`
	Tags   []string `yaml:"tags"`
	Status string   `yaml:"status"`
	Path   string
	Body   string
}

func Parse

func Parse(content []byte) (*Doc, error)

type Store

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

func New

func New(docsDir string, allowedCategories []string) (*Store, error)

func (*Store) AppendSection

func (s *Store) AppendSection(id, heading, content string) error

func (*Store) Create

func (s *Store) Create(doc Doc, content []byte) (string, error)

func (*Store) Exists

func (s *Store) Exists(id string) bool

func (*Store) Get

func (s *Store) Get(id string) (string, error)

func (*Store) List

func (s *Store) List() ([]Doc, error)

func (*Store) SetStatus

func (s *Store) SetStatus(id, status string) error

Jump to

Keyboard shortcuts

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