doc-smith-publish

Publish Doc-Smith documentation to cloud or existing websites.

9|Updated Dec 22, 2025
One-click install
npx skills add https://github.com/AIGNE-io/doc-smith-skills --skill doc-smith-publish
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-smith-publish
Source: https://github.com/AIGNE-io/doc-smith-skills/tree/main/skills/doc-smith-publish
Command: npx skills add https://github.com/AIGNE-io/doc-smith-skills --skill doc-smith-publish

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @aigne/cli, @aigne/publish-docs, @aigne/secrets, @blocklet/payment-broker-client, chalk, fs-extra, open, p-limit, p-retry, ufo, yaml, and includes scripts (resource) components.

What problem does it solve?

Publishes Doc-Smith generated documentation to online platforms, enabling quick deployment and consistent release cycles across the web.

Core Features & Use Cases

  • Publish to DocSmith Cloud, an existing website, or create a new website, with automated asset upload and site authorization handling.
  • Read destination and metadata from workspace config, translate meta as needed, and ensure consistency across languages.
  • Use-case: When you need to release the latest project docs to a live URL, with minimal manual steps and automated validation.

Quick Start

Use the doc-smith-publish skill to publish your current workspace docs to a specified URL or to create a new site.

Frequently Asked Questions about doc-smith-publish

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I publish generated documentation to a live website from a workspace?

To publish generated documentation to a live website, this skill validates your workspace state, resolves publish targets from config.yaml, prepares translated metadata, and deploys your docs to a new or existing site.

Can I deploy documentation directly to cloud hosting platforms?

Yes, you can deploy documentation directly to DocSmith Cloud. The skill handles automated asset uploads and site authorization to ensure a consistent release cycle across web platforms.

What is the best way to handle site authorization when deploying docs online?

The best way to handle site authorization when deploying docs online is through this skill's automated validation process, which reads destination metadata from your workspace config and manages authorization during deployment.

Does publishing translated documentation require manual metadata preparation?

Publishing translated documentation does not require manual metadata preparation because the skill automatically translates metadata as needed from your workspace config.yaml to ensure consistency across languages.

Why does my documentation deployment fail before reaching the target URL?

Documentation deployment may fail if the workspace state is invalid. The skill validates the workspace state and resolves publish targets from config.yaml before proceeding with asset uploads and deployment.

Do I need a config.yaml file to publish docs to an existing website?

Yes, you need a config.yaml file to publish docs to an existing website. The skill resolves publish targets and reads destination metadata from this configuration file before preparing translated metadata for deployment.