showdoc

package

v1.1.0 Latest Latest Go to latest Published: Dec 30, 2022 License: Apache-2.0 Imports: 3 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/whaios/showdocdb

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func UpdateByApi(catName, pageTitle, sNumber string, content string) error
type ErrResult
- func (p *ErrResult) Error() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ApiKey   = ""
	ApiToken = ""
)

认证凭证。登录showdoc，进入具体项目后，点击右上角的”项目设置”-“开放API”便可看到

View Source

var Host = "https://www.showdoc.com.cn" // ShowDoc地址，默认 "https://www.showdoc.com.cn"

Functions ¶

func UpdateByApi ¶

func UpdateByApi(catName, pageTitle, sNumber string, content string) error

UpdateByApi ShowDoc提供的开放API接口，使用api_key+api_token进行认证。参考官方文档 https://www.showdoc.com.cn/page/102098

@param catName 可选参数。当页面文档处于目录下时，请传递目录名。当目录名不存在时，showdoc会自动创建此目录。需要创建多层目录的时候请用斜杆隔开，例如 “一层/二层/三层”。 @param pageTitle 页面标题。请保证其唯一。（或者，当页面处于目录下时，请保证页面标题在该目录下唯一）。当页面标题不存在时，showdoc将会创建此页面。当页面标题存在时，将用page_content更新其内容 @param sNumber 可选，页面序号。默认是99。数字越小，该页面越靠前

Types ¶

type ErrResult ¶

type ErrResult struct {
	ErrorCode    int    `json:"error_code"` // 返回 0 表示成功
	ErrorMessage string `json:"error_message"`
}

func (*ErrResult) Error ¶

func (p *ErrResult) Error() error

Source Files ¶

View all Source files

showdoc.go

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