wiki

Documentation

Index

• Constants
• func AddWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, ...) error
• func DeleteWiki(ctx context.Context, repo *repo_model.Repository) error
• func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, ...) (err error)
• func EditWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, ...) error
• func FilenameToName(filename string) (string, error)
• func InitWiki(ctx context.Context, repo *repo_model.Repository) error
• func NameToFilename(name string) string
• func NameToSubURL(name string) string
• func NormalizeWikiName(name string) string

Constants

const (
	DefaultRemote = "origin"
	DefaultBranch = "master"
)

Functions

func AddWikiPage

func AddWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName, content, message string) error

AddWikiPage adds a new wiki page with a given wikiPath.

func DeleteWiki

func DeleteWiki(ctx context.Context, repo *repo_model.Repository) error

DeleteWiki removes the actual and local copy of repository wiki.

func DeleteWikiPage

func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName string) (err error)

DeleteWikiPage deletes a wiki page identified by its path.

func EditWikiPage

func EditWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, oldWikiName, newWikiName, content, message string) error

EditWikiPage updates a wiki page identified by its wikiPath, optionally also changing wikiPath.

func FilenameToName

func FilenameToName(filename string) (string, error)

FilenameToName converts a wiki filename to its corresponding page name.

func InitWiki

func InitWiki(ctx context.Context, repo *repo_model.Repository) error

InitWiki initializes a wiki for repository, it does nothing when repository already has wiki.

func NameToFilename

func NameToFilename(name string) string

NameToFilename converts a wiki name to its corresponding filename.

func NameToSubURL

func NameToSubURL(name string) string

NameToSubURL converts a wiki name to its corresponding sub-URL.

func NormalizeWikiName

func NormalizeWikiName(name string) string

NormalizeWikiName normalizes a wiki name