Dagger
Search

markdown

No long description provided.

Installation

dagger install github.com/tuannvm/blogenetes/markdown@2dd149c7db91c999d3300a4be2ed2712c22e3c88

Entrypoint

Return Type 
Markdown
Example
dagger -m github.com/tuannvm/blogenetes/markdown@2dd149c7db91c999d3300a4be2ed2712c22e3c88 call \

func (m *MyModule) Example() *dagger.Markdown  {
	return dag.
			Markdown()
}
@function
def example() -> dagger.Markdown:
	return (
		dag.markdown()
	)
@func()
example(): Markdown {
	return dag
		.markdown()
}

Types

Markdown 🔗

generateMarkdown() 🔗

GenerateMarkdown creates a markdown document from the summary Returns an error if the summary is nil or if the title is empty

Return Type 
Content !
Arguments
NameTypeDefault ValueDescription
titleString !-No description provided
summarySummary !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(title string, summary *dagger.MarkdownSummary) *dagger.MarkdownContent  {
	return dag.
			Markdown().
			GenerateMarkdown(title, summary)
}
@function
def example(title: str, summary: dagger.MarkdownSummary) -> dagger.MarkdownContent:
	return (
		dag.markdown()
		.generate_markdown(title, summary)
	)
@func()
example(title: string, summary: MarkdownSummary): MarkdownContent {
	return dag
		.markdown()
		.generateMarkdown(title, summary)
}

processMarkdown() 🔗

ProcessMarkdown is the Dagger function that will be called from the pipeline

Return Type 
Content !
Arguments
NameTypeDefault ValueDescription
titleString !-No description provided
summarySummary !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(title string, summary *dagger.MarkdownSummary) *dagger.MarkdownContent  {
	return dag.
			Markdown().
			ProcessMarkdown(title, summary)
}
@function
def example(title: str, summary: dagger.MarkdownSummary) -> dagger.MarkdownContent:
	return (
		dag.markdown()
		.process_markdown(title, summary)
	)
@func()
example(title: string, summary: MarkdownSummary): MarkdownContent {
	return dag
		.markdown()
		.processMarkdown(title, summary)
}

Content 🔗

MarkdownContent represents the final markdown document

title() 🔗

Return Type 
String !
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context, title string, summary *dagger.MarkdownSummary) string  {
	return dag.
			Markdown().
			ProcessMarkdown(title, summary).
			Title(ctx)
}
@function
async def example(title: str, summary: dagger.MarkdownSummary) -> str:
	return await (
		dag.markdown()
		.process_markdown(title, summary)
		.title()
	)
@func()
async example(title: string, summary: MarkdownSummary): Promise<string> {
	return dag
		.markdown()
		.processMarkdown(title, summary)
		.title()
}

date() 🔗

Return Type 
String !
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context, title string, summary *dagger.MarkdownSummary) string  {
	return dag.
			Markdown().
			ProcessMarkdown(title, summary).
			Date(ctx)
}
@function
async def example(title: str, summary: dagger.MarkdownSummary) -> str:
	return await (
		dag.markdown()
		.process_markdown(title, summary)
		.date()
	)
@func()
async example(title: string, summary: MarkdownSummary): Promise<string> {
	return dag
		.markdown()
		.processMarkdown(title, summary)
		.date()
}

content() 🔗

Return Type 
String !
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context, title string, summary *dagger.MarkdownSummary) string  {
	return dag.
			Markdown().
			ProcessMarkdown(title, summary).
			Content(ctx)
}
@function
async def example(title: str, summary: dagger.MarkdownSummary) -> str:
	return await (
		dag.markdown()
		.process_markdown(title, summary)
		.content()
	)
@func()
async example(title: string, summary: MarkdownSummary): Promise<string> {
	return dag
		.markdown()
		.processMarkdown(title, summary)
		.content()
}

Summary 🔗

Summary represents the structured summary of content

summary() 🔗

Return Type 
String !
Example
Function MarkdownSummary.summary is not accessible from the markdown module
Function MarkdownSummary.summary is not accessible from the markdown module
Function MarkdownSummary.summary is not accessible from the markdown module
Function MarkdownSummary.summary is not accessible from the markdown module

keyPoints() 🔗

Return Type 
[String ! ] !
Example
Function MarkdownSummary.keyPoints is not accessible from the markdown module
Function MarkdownSummary.keyPoints is not accessible from the markdown module
Function MarkdownSummary.keyPoints is not accessible from the markdown module
Function MarkdownSummary.keyPoints is not accessible from the markdown module