playbooks

home / skills / openclaw / skills / markdown-publish-share

markdown-publish-share skill

/skills/operator-auteng-ai/markdown-publish-share

This skill publishes markdown to a shareable link via curl, supporting mermaid, KaTeX, and code blocks, and returns the rendered document URL.

npx playbooks add skill openclaw/skills --skill markdown-publish-share

Review the files below or copy the command above to add this skill to your agents.

Files (3)
SKILL.md
1.6 KB
---
name: markdown-publish-share
description: Publish markdown and return share links using curl. Support markdown with mermaid diagrams such as component diagrams, flowcharts, and sequence diagrams. Also supports KaTex and code blocks. AutEng will return a shareable link to the published rendered document. Use cases include Software Architecture diagrams and documentation, Maths and Physics derivations and Systems documentation.
---

# AutEng Docs Curl Publish

Use this endpoint:

`https://auteng.ai/api/tools/docs/publish-markdown/`

Send JSON with:

- `markdown` (required)
- `title` (optional)
- `expires_hours` (optional)

Use this command to publish markdown:

```bash
curl -sS -X POST "https://auteng.ai/api/tools/docs/publish-markdown/" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "markdown": "# API Test\n\nHello from curl.",
  "title": "API Test",
  "expires_hours": 24
}
JSON
```

Extract only the share URL:

```bash
curl -sS -X POST "https://auteng.ai/api/tools/docs/publish-markdown/" \
  -H "Content-Type: application/json" \
  -d '{"markdown":"# Hello\n\nPublished from curl."}' \
  | jq -r '.share_url'
```

Extract a compact success payload:

```bash
curl -sS -X POST "https://auteng.ai/api/tools/docs/publish-markdown/" \
  -H "Content-Type: application/json" \
  -d '{"markdown":"# Hello\n\nPublished from curl."}' \
  | jq '{title, share_url, expires_at}'
```

Treat any response without `share_url` as an error and show the full JSON body.


For full documentation and supported markdown for mermaid, KaTeX and code syntax along with examples, see https://auteng.ai/llms.txt

Overview

This skill publishes Markdown documents via a simple curl API and returns a shareable link to the rendered output. It supports Mermaid diagrams (component, flowchart, sequence), KaTeX math, and fenced code blocks so you can share architecture diagrams, mathematics, and technical docs quickly. The service returns a JSON response containing a share_url and optional metadata like title and expiry.

How this skill works

You POST a JSON payload to the publish endpoint containing at minimum the markdown field, and optionally title and expires_hours. The endpoint returns JSON; extract share_url to get the public rendered document link. If the response lacks share_url, treat it as an error and inspect the full JSON body. Example curl commands show how to post content and extract either the URL or a compact success payload.

When to use it

  • Share software architecture diagrams and documentation that include Mermaid diagrams.
  • Publish math or physics derivations using KaTeX for formatted equations.
  • Quickly distribute code samples with syntax highlighting via fenced code blocks.
  • Create short-lived documentation by setting an expiry time.
  • Automate publishing from scripts or CI/CD pipelines using curl.

Best practices

  • Always include a descriptive title field to make shared links easier to identify.
  • Validate the returned JSON and treat missing share_url as a publish failure.
  • Use expires_hours for temporary drafts or sensitive content to limit exposure.
  • Keep large diagrams modular to avoid rendering issues; test locally before publishing.
  • Sanitize any user-supplied content if publishing from public-facing systems.

Example use cases

  • Publish a system component diagram with Mermaid and share the link with stakeholders.
  • Render a LaTeX-heavy math note using KaTeX and send the share_url to collaborators.
  • Embed code snippets and walkthroughs in a single Markdown doc and publish for review.
  • Automate daily build notes or changelogs from CI by posting markdown and returning a link.
  • Archive technical write-ups with a controlled expiry for temporary access.

FAQ

What fields are required in the POST payload?

Only markdown is required. title and expires_hours are optional.

How do I detect publishing errors?

If the JSON response does not include share_url, treat it as an error and inspect the full JSON body for details.