Skip to content

Add Swift DocC documentation - #26

Open
DandyLyons wants to merge 3 commits into
mainfrom
feat/docc-documentation
Open

Add Swift DocC documentation#26
DandyLyons wants to merge 3 commits into
mainfrom
feat/docc-documentation

Conversation

@DandyLyons

Copy link
Copy Markdown
Owner

Summary

  • Added comprehensive Swift DocC documentation for both the MarkdownUtilities library and md-utils CLI
  • Includes getting started guides, API documentation, command references, and workflow examples
  • Covers integration with Hugo, Obsidian, and general Markdown workflows
  • Documents all current CLI commands (fm-get, fm-set, fm-list, fm-dump, body, toc, to-text)

Important Note

⚠️ This initial documentation draft was generated with Claude AI and requires human review and revision before being considered final. While the structure and content provide a solid starting point, it should be carefully reviewed for:

  • Technical accuracy
  • Completeness
  • Consistency with actual implementation
  • Voice and style
  • Examples and code snippets

Documentation Structure

MarkdownUtilities Library

  • Getting Started guide
  • MarkdownDocument overview
  • FrontMatter operations (overview, CRUD)
  • Format conversion (plain text)
  • Table of Contents generation
  • Integration guide

md-utils CLI

  • Getting Started guide
  • Global options reference
  • Command documentation for all commands
  • Workflow guides:
    • Shell scripting and automation
    • General Markdown workflows
    • Obsidian integration
    • Hugo static site generation

Test plan

  • Review documentation for technical accuracy
  • Verify all code examples work as documented
  • Check that command syntax matches actual CLI behavior
  • Build DocC locally with swift package generate-documentation
  • Review generated documentation site for navigation and clarity

🤖 Generated with Claude Code

DandyLyons and others added 3 commits January 25, 2026 16:26
Added the swift-docc-plugin package to the dependencies in Package.swift to enable documentation generation support. Updated Package.resolved to include swift-docc-plugin and swift-docc-symbolkit.
Added comprehensive DocC documentation covering:
- MarkdownUtilities library API and usage patterns
- md-utils CLI commands and workflows
- Getting started guides for both targets
- Workflow examples for Hugo, Obsidian, and general Markdown

Note: This initial documentation draft was generated with Claude AI
and requires human review and revision before being considered final.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant