lark_docs_md

package module

v0.1.0 Latest Latest Go to latest Published: Feb 8, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/chyroc/lark_docs_md

Links

Open Source Insights

README ¶

lark_docs_md

Install

go get github.com/chyroc/lark_docs_md

Usage

package main

import (
	"context"
	"fmt"

	"github.com/chyroc/lark"
	"github.com/chyroc/lark/larkext"
	"github.com/chyroc/lark_docs_md"
)

func main() {
	larkClient := lark.New(lark.WithAppCredential("app-id", "app-secret"))
	docToken := "doc-token"

	// 这一步是获取 doc 内容
	doc, err := larkext.NewDoc(larkClient, docToken).Content(context.Background())
	if err != nil {
		panic(err)
	}

	// 转化为 markdown
	result := lark_docs_md.DocMarkdown(context.Background(), doc, &lark_docs_md.FormatOpt{
		LarkClient: larkClient,

		// 如果需要下载图片等静态文件，请配置这两项
		// StaticDir:  "static",
		// FilePrefix: "static",

		// 如果不需要下载文件，而替换为 24 小时有效的链接，请配置这个项
		StaticAsURL: true,
	})

	// 输出
	fmt.Println(result)
}

Documentation ¶

Index ¶

func DocBitableMarkdown(r *lark.DocBitable, opt *FormatOpt) string
func DocBlockMarkdown(r *lark.DocBlock, opt *FormatOpt) string
func DocBodyMarkdown(r *lark.DocBody, opt *FormatOpt) string
func DocCalloutMarkdown(r *lark.DocCallout, opt *FormatOpt) string
func DocChatGroupMarkdown(r *lark.DocChatGroup, opt *FormatOpt) string
func DocCodeMarkdown(r *lark.DocCode, opt *FormatOpt) string
func DocDiagramMarkdown(r *lark.DocDiagram, opt *FormatOpt) string
func DocDocsAppMarkdown(r *lark.DocDocsApp, opt *FormatOpt) string
func DocDocsLinkMarkdown(r *lark.DocDocsLink, opt *FormatOpt) string
func DocEmbeddedPageMarkdown(r *lark.DocEmbeddedPage, opt *FormatOpt) string
func DocEquationMarkdown(r *lark.DocEquation, opt *FormatOpt) string
func DocFileMarkdown(r *lark.DocFile, opt *FormatOpt) string
func DocGalleryMarkdown(r *lark.DocGallery, opt *FormatOpt) string
func DocHorizontalLineMarkdown(r *lark.DocHorizontalLine, opt *FormatOpt) string
func DocImageItemMarkdown(r *lark.DocImageItem, opt *FormatOpt) string
func DocJiraMarkdown(r *lark.DocJira, opt *FormatOpt) string
func DocMarkdown(ctx context.Context, doc *lark.DocContent, opt *FormatOpt) string
func DocParagraphElementMarkdown(r *lark.DocParagraphElement, opt *FormatOpt) string
func DocParagraphMarkdown(r *lark.DocParagraph, opt *FormatOpt) string
func DocPersonMarkdown(r *lark.DocPerson, opt *FormatOpt) string
func DocPollMarkdown(r *lark.DocPoll, opt *FormatOpt) string
func DocReminderMarkdown(r *lark.DocReminder, opt *FormatOpt) string
func DocSheetMarkdown(r *lark.DocSheet, opt *FormatOpt) string
func DocTableMarkdown(r *lark.DocTable, opt *FormatOpt) string
func DocTextRunMarkdown(r *lark.DocTextRun, opt *FormatOpt) string
func DocUndefinedBlockMarkdown(r *lark.DocUndefinedBlock, opt *FormatOpt) string
func DocUndefinedElementMarkdown(r *lark.DocUndefinedElement, opt *FormatOpt) string
type FormatOpt

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DocBitableMarkdown ¶

func DocBitableMarkdown(r *lark.DocBitable, opt *FormatOpt) string

func DocBlockMarkdown ¶

func DocBlockMarkdown(r *lark.DocBlock, opt *FormatOpt) string

func DocBodyMarkdown ¶

func DocBodyMarkdown(r *lark.DocBody, opt *FormatOpt) string

func DocCalloutMarkdown ¶

func DocCalloutMarkdown(r *lark.DocCallout, opt *FormatOpt) string

func DocChatGroupMarkdown ¶

func DocChatGroupMarkdown(r *lark.DocChatGroup, opt *FormatOpt) string

func DocCodeMarkdown ¶

func DocCodeMarkdown(r *lark.DocCode, opt *FormatOpt) string

func DocDiagramMarkdown ¶

func DocDiagramMarkdown(r *lark.DocDiagram, opt *FormatOpt) string

func DocDocsAppMarkdown ¶

func DocDocsAppMarkdown(r *lark.DocDocsApp, opt *FormatOpt) string

func DocDocsLinkMarkdown ¶

func DocDocsLinkMarkdown(r *lark.DocDocsLink, opt *FormatOpt) string

func DocEmbeddedPageMarkdown ¶

func DocEmbeddedPageMarkdown(r *lark.DocEmbeddedPage, opt *FormatOpt) string

func DocEquationMarkdown ¶

func DocEquationMarkdown(r *lark.DocEquation, opt *FormatOpt) string

func DocFileMarkdown ¶

func DocFileMarkdown(r *lark.DocFile, opt *FormatOpt) string

func DocGalleryMarkdown ¶

func DocGalleryMarkdown(r *lark.DocGallery, opt *FormatOpt) string

func DocHorizontalLineMarkdown ¶

func DocHorizontalLineMarkdown(r *lark.DocHorizontalLine, opt *FormatOpt) string

func DocImageItemMarkdown ¶

func DocImageItemMarkdown(r *lark.DocImageItem, opt *FormatOpt) string

func DocJiraMarkdown ¶

func DocJiraMarkdown(r *lark.DocJira, opt *FormatOpt) string

func DocMarkdown ¶

func DocMarkdown(ctx context.Context, doc *lark.DocContent, opt *FormatOpt) string

func DocParagraphElementMarkdown ¶

func DocParagraphElementMarkdown(r *lark.DocParagraphElement, opt *FormatOpt) string

func DocParagraphMarkdown ¶

func DocParagraphMarkdown(r *lark.DocParagraph, opt *FormatOpt) string

func DocPersonMarkdown ¶

func DocPersonMarkdown(r *lark.DocPerson, opt *FormatOpt) string

func DocPollMarkdown ¶

func DocPollMarkdown(r *lark.DocPoll, opt *FormatOpt) string

func DocReminderMarkdown ¶

func DocReminderMarkdown(r *lark.DocReminder, opt *FormatOpt) string

func DocSheetMarkdown ¶

func DocSheetMarkdown(r *lark.DocSheet, opt *FormatOpt) string

func DocTableMarkdown ¶

func DocTableMarkdown(r *lark.DocTable, opt *FormatOpt) string

func DocTextRunMarkdown ¶

func DocTextRunMarkdown(r *lark.DocTextRun, opt *FormatOpt) string

func DocUndefinedBlockMarkdown ¶

func DocUndefinedBlockMarkdown(r *lark.DocUndefinedBlock, opt *FormatOpt) string

func DocUndefinedElementMarkdown ¶

func DocUndefinedElementMarkdown(r *lark.DocUndefinedElement, opt *FormatOpt) string

Types ¶

type FormatOpt ¶

type FormatOpt struct {
	LarkClient  *lark.Lark // lark 客户端
	StaticDir   string     // 如果需要下载静态文件，那么需要指定静态文件的目录
	FilePrefix  string     // 针对静态文件，需要指定文件在 Markdown 中的前缀
	StaticAsURL bool       // 不下载静态文件，直接把静态文件的 URL 插入到 Markdown 中
	// contains filtered or unexported fields
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
_examples

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