wiki

package

v0.0.0-...-77dcaa2 Latest Latest Go to latest Published: Nov 16, 2022 License: MIT Imports: 19 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

This section is empty.

View Source

var ArticleTemplate = `` /* 3822-byte string literal not displayed */

ArticleTemplate is the default template for articles

View Source

var EditorTemplate = `` /* 1477-byte string literal not displayed */

EditorTemplate is the default template for the wiki editor

This section is empty.

type ArticleMeta struct {
	Title      string `yml:"title"`
	LastEdit   string `yml:"lastEditedAt"`
	LastEditor string `yml:"lastEditedBy"`
}

ArticleMeta specifies all stuff

type HeadLevel struct {
	Name     string
	ID       string
	Children []HeadLevel
	Depth    int
}

HeadLevel specifies data about what to be put in the index

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

Wiki is an instance for the wiki element

func NewWiki(manager manager.Manager, articleTempl, editorTempl string) Wiki

NewWiki returns a new Wiki instance

func (wiki *Wiki) ExtractMeta(v *ArticleMeta, file []byte) ([]byte, error)

ExtractMeta gives the meta information from a byte slice

func (wiki *Wiki) GetSource(w http.ResponseWriter, r *http.Request)

GetSource returns the source for an article

func (wiki *Wiki) HandleEdit(w http.ResponseWriter, r *http.Request)

HandleEdit handles an edit

func (wiki *Wiki) ReadMarkdown(name string) []byte

ReadMarkdown reads the markdown file for an article

func (wiki *Wiki) RenderMarkdown(w http.ResponseWriter, r *http.Request)

RenderMarkdown renders the markdown of the article

func (wiki *Wiki) Router() chi.Router

Router returns a valid router for the wiki module

func (wiki *Wiki) WikiEditor(w http.ResponseWriter, r *http.Request)

WikiEditor renders the editor view