wiki package - github.com/liuyangovo/gitea/services/wiki

Details

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 InitWiki(ctx context.Context, repo *repo_model.Repository) error
func WebPathSegments(s WebPath) []string
func WebPathToGitPath(s WebPath) string
func WebPathToURLPath(s WebPath) string
func WebPathToUserTitle(s WebPath) (dir, display string)
type WebPath

Constants ¶

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

Variables ¶

This section is empty.

Functions ¶

func AddWikiPage ¶

func AddWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName WebPath, 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 WebPath) (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 WebPath, content, message string) error

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

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 WebPathSegments ¶

func WebPathSegments(s WebPath) []string

func WebPathToGitPath ¶

func WebPathToGitPath(s WebPath) string

func WebPathToURLPath ¶

func WebPathToURLPath(s WebPath) string

func WebPathToUserTitle ¶

func WebPathToUserTitle(s WebPath) (dir, display string)

Types ¶

type WebPath ¶

type WebPath string

func GitPathToWebPath ¶

func GitPathToWebPath(s string) (wp WebPath, err error)

func UserTitleToWebPath ¶

func UserTitleToWebPath(base, title string) WebPath

func WebPathFromRequest ¶

func WebPathFromRequest(s string) WebPath

Source Files ¶

View all Source files

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