Skip to content

Commit

Permalink
Add ac:box macro
Browse files Browse the repository at this point in the history
  • Loading branch information
rofafor committed Mar 26, 2021
1 parent 7cd0ebd commit 82d418e
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,20 @@ By default, mark provides several built-in templates and macros:
- true
- false

* template `ac:box`to include info, tip, note, and warning text boxes. Parameters:
- Name: select box style
- info
- tip
- note
- warning
- Icon: show information/tip/exclamation mark/warning icon
- true
- false
- Title: title text of the box
- Body: text to display in the box

See: https://confluence.atlassian.com/conf59/info-tip-note-and-warning-macros-792499127.html

* template `ac:jira:ticket` to include JIRA ticket link. Parameters:
- Ticket: Jira ticket number like BUGS-123.

Expand Down Expand Up @@ -185,6 +199,27 @@ This is my article.
* :todo: Publish Article
```

### Insert Colored Text Box

**article.md**

```markdown
<!-- Space: TEST -->
<!-- Title: Announcement -->

<!-- Macro: :box:(.+):(.*):(.+):
Template: ac:box
Icon: true
Name: ${1}
Title: ${2}
Body: ${3} -->

:box:info::Foobar:
:box:tip:Tip of day:Foobar:
:box:note::Foobar:
:box:warning:Alert!:Foobar:
```

### Insert Table of Contents

```markdown
Expand Down
12 changes: 12 additions & 0 deletions pkg/mark/stdlib/stdlib.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,18 @@ func templates(api *confluence.API) (*template.Template, error) {
`</ac:structured-macro>`,
),

/* https://confluence.atlassian.com/conf59/info-tip-note-and-warning-macros-792499127.html */

`ac:box`: text(
`<ac:structured-macro ac:name="{{ .Name }}">{{printf "\n"}}`,
`<ac:parameter ac:name="icon">{{ or .Icon "false" }}</ac:parameter>{{printf "\n"}}`,
`<ac:parameter ac:name="title">{{ or .Title "" }}</ac:parameter>{{printf "\n"}}`,
`<ac:rich-text-body>{{printf "\n"}}`,
`{{ .Body }}{{printf "\n"}}`,
`</ac:rich-text-body>{{printf "\n"}}`,
`</ac:structured-macro>{{printf "\n"}}`,
),

/* https://confluence.atlassian.com/conf59/table-of-contents-macro-792499210.html */

`ac:toc`: text(
Expand Down

0 comments on commit 82d418e

Please sign in to comment.