markdown

package

v0.0.0-...-d309816 Latest Latest Go to latest Published: Jan 5, 2023 License: MIT Imports: 9 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

Documentation ¶

Overview ¶

* @Author: tj * @Date: 2022-11-02 10:35:02 * @LastEditors: tj * @LastEditTime: 2022-12-05 10:13:54 * @FilePath: \createApiMarkdown\markdown\data.go

* @Author: tj * @Date: 2022-10-26 18:07:11 * @LastEditors: tj * @LastEditTime: 2022-11-21 17:00:11 * @FilePath: \createApiMarkdown\markdown\markdown.go

* @Author: tj * @Date: 2022-11-02 10:51:44 * @LastEditors: tj * @LastEditTime: 2022-12-05 10:14:00 * @FilePath: \createApiMarkdown\markdown\md2html.go

* @Author: tj * @Date: 2022-11-02 11:05:05 * @LastEditors: tj * @LastEditTime: 2022-12-05 10:14:05 * @FilePath: \createApiMarkdown\markdown\option.go

* @Author: tj * @Date: 2022-10-27 17:28:40 * @LastEditors: tj * @LastEditTime: 2022-12-05 10:17:06 * @FilePath: \createApiMarkdown\markdown\request.go

* @Author: tj * @Date: 2022-10-27 17:29:49 * @LastEditors: tj * @LastEditTime: 2022-12-05 10:17:10 * @FilePath: \createApiMarkdown\markdown\response.go

* @Author: tj * @Date: 2022-10-26 18:07:40 * @LastEditors: tj * @LastEditTime: 2022-11-21 16:54:22 * @FilePath: \createApiMarkdown\markdown\template.go

Index ¶

Constants
type Markdown
- func New(doc *document.Document, options ...Option) *Markdown
- func (m *Markdown) Generate(file string) error
type Option
- func WithMd2Html(isMd2Html bool) Option
type SubTable

Constants ¶

View Source

const TplBody = `` /* 199-byte string literal not displayed */

View Source

const TplPage = `# {title}
> 版本号：{version}<br>
> BaseUrl: {url}<br>
> Header: {headerList}<br>
> ApiList: {apiList}<br>
{body}
`

View Source

const TplReqParam = `|{name}   |{kind}        |{required}      |{description}    |
`

View Source

const TplReqTable = `
|字段      |字段类型       |必填     |字段说明    |
|:--:|:--:|:--:|:--:|
{params}`

View Source

const TplRespParam = `|{name}   |{kind}        |{description}    |
`

View Source

const TplRespTable = `
|字段      |字段类型       |字段说明    |
|:--:|:--:|:--:|
{params}`

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Markdown ¶

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

func New ¶

func New(doc *document.Document, options ...Option) *Markdown

func (*Markdown) Generate ¶

func (m *Markdown) Generate(file string) error

type Option ¶

type Option func(*Markdown)

func WithMd2Html ¶

func WithMd2Html(isMd2Html bool) Option

type SubTable ¶

type SubTable struct {
	Title  string
	Fields []*document.Field
}

Source Files ¶

View all Source files

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