docgen

Documentation

Index

• Constants
• type Docs
  • func (Docs) Generate(format string) error
  • func (Docs) Init() error

Constants

const FullPermissions = 0o777

FullPermissions sets permissions based on same model as gomarkdoc.

Types

type Docs

type Docs mg.Namespace

Docs contains all the Doc related tasks.

func (Docs) Generate

func (Docs) Generate(format string) error

📘 Docs generate md docs. Required: Format (azure-devops, github, gitlab).

func (Docs) Init

func (Docs) Init() error

⚙️ Init initializes the tooling for Docs.