Documentation
¶
Overview ¶
Package files is used to get paths to different files Mycorrhiza uses. Also see cfg.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConfigPath ¶ added in v1.2.0
func ConfigPath() string
ConfigPath returns the path to the config file.
func FileInRoot ¶ added in v1.8.0
FileInRoot returns full path for the given filename if it was placed in the root of the wiki structure.
func GitRepo ¶ added in v1.2.0
func GitRepo() string
GitRepo returns the path to the Git repository of the wiki.
func HyphaeDir ¶ added in v1.2.0
func HyphaeDir() string
HyphaeDir returns the path to hyphae storage. A separate function is needed to easily know where a general storage path is needed rather than a concrete Git or the whole wiki storage path, so that we could easily refactor things later if we'll ever support different storages.
func PrepareWikiRoot ¶ added in v1.2.0
func PrepareWikiRoot() error
PrepareWikiRoot ensures all needed directories and files exist and have correct permissions.
func StaticFiles ¶ added in v1.2.0
func StaticFiles() string
StaticFiles returns the path to static files directory
func TokensJSON ¶
func TokensJSON() string
TokensJSON returns the path to the JSON user tokens storage.
func UserCredentialsJSON ¶ added in v1.3.0
func UserCredentialsJSON() string
UserCredentialsJSON returns the path to the JSON user credentials storage.
Types ¶
This section is empty.