mdoc

package module

v0.0.0-...-23bed4d Latest Latest Go to latest Published: Apr 28, 2024 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/zrcoder/mdoc

Links

Open Source Insights

README ¶

mdoc

A dead simple document server

Documentation ¶

Index ¶

func EnableLog()
func GetConfig() *model.Config
func InitWithFile(customConfigFile string) (err error)
func Serve(cfg *model.Config) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func EnableLog ¶

func EnableLog()

func GetConfig ¶

func GetConfig() *model.Config

func InitWithFile ¶

func InitWithFile(customConfigFile string) (err error)

InitWithFile initializes configuration from conf assets and given custom configuration file. If `customConf` is empty, it falls back to default location, i.e. "<WORK DIR>/custom".

func Serve ¶

func Serve(cfg *model.Config) error

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
mdoc
internal
doc
log
model
osutil
static
static/i18n
static/templates

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