PyPI - moai-adk - Versions diffs - 0.34.0__py3-none-any.whl → 1.1.0__py3-none-any.whl - Mend

moai-adk 0.34.0py3-none-any.whl → 1.1.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (524) hide show

moai_adk/templates/.claude/skills/moai-docs-generation/modules/multi-format-output.md CHANGED Viewed

@@ -1,178 +1,185 @@
-# Multi-Format Output Generation
+# Multi-Format Documentation Output
 ## Overview
-Comprehensive documentation generation supporting HTML sites, PDF documents, static sites, and various output formats with responsive design and professional styling.
-## Quick Implementation
-```python
-from jinja2 import Template
-import markdown
-class HTMLDocGenerator:
- def __init__(self):
- self.templates = self.load_templates()
- def generate_html_site(self, documentation: Dict, output_dir: str):
- """Generate a complete HTML documentation site."""
- # Generate index page
- index_html = self.generate_index_page(documentation)
- self.write_file(output_dir, "index.html", index_html)
- # Generate API reference pages
- self.generate_api_pages(documentation, output_dir)
- # Generate tutorial pages
- self.generate_tutorial_pages(documentation, output_dir)
- # Generate CSS and assets
- self.generate_assets(output_dir)
- def generate_index_page(self, documentation: Dict) -> str:
- """Generate the main index page."""
- template = Template("""
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="UTF-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>{{ title }}</title>
- <link rel="stylesheet" href="assets/style.css">
-</head>
-<body>
- <nav class="sidebar">
- <div class="logo">
- <h2>{{ title }}</h2>
- </div>
- <ul class="nav-menu">
- <li><a href="index.html" class="active">Home</a></li>
- <li><a href="api/index.html">API Reference</a></li>
- <li><a href="tutorials/index.html">Tutorials</a></li>
- <li><a href="cookbook.html">Cookbook</a></li>
- </ul>
- </nav>
- <main class="content">
- <section class="hero">
- <h1>{{ title }}</h1>
- <p>{{ description }}</p>
- <div class="cta-buttons">
- <a href="tutorials/getting-started.html" class="btn primary">Get Started</a>
- <a href="api/index.html" class="btn secondary">API Docs</a>
- </div>
- </section>
- <section class="features">
- <h2>Key Features</h2>
- <div class="feature-grid">
- {% for feature in features %}
- <div class="feature-card">
- <h3>{{ feature.name }}</h3>
- <p>{{ feature.description }}</p>
- </div>
- {% endfor %}
- </div>
- </section>
- <section class="quick-start">
- <h2>Quick Start</h2>
- <pre><code>{{ quick_start_example }}</code></pre>
- </section>
- </main>
- <script src="assets/script.js"></script>
-</body>
-</html>
- """)
- return template.render(
- title=documentation.get("title", "API Documentation"),
- description=documentation.get("description", ""),
- features=documentation.get("features", []),
- quick_start_example=documentation.get("quick_start", "")
- )
- def generate_pdf_documentation(self, markdown_content: str, output_path: str):
- """Generate PDF from Markdown content."""
- try:
- import weasyprint
- # Convert Markdown to HTML
- html_content = markdown.markdown(
- markdown_content,
- extensions=['tables', 'fenced_code', 'toc']
- )
- # Add CSS styling
- styled_html = f"""
- <!DOCTYPE html>
- <html>
- <head>
- <style>
- body {{ font-family: Arial, sans-serif; line-height: 1.6; margin: 40px; }}
- h1 {{ color: #333; border-bottom: 2px solid #333; }}
- h2 {{ color: #666; }}
- code {{ background: #f4f4f4; padding: 2px 4px; border-radius: 3px; }}
- pre {{ background: #f4f4f4; padding: 10px; border-radius: 5px; overflow-x: auto; }}
- table {{ border-collapse: collapse; width: 100%; }}
- th, td {{ border: 1px solid #ddd; padding: 8px; text-align: left; }}
- </style>
- </head>
- <body>
- {html_content}
- </body>
- </html>
- """
- # Generate PDF
- weasyprint.HTML(string=styled_html).write_pdf(output_path)
- except ImportError:
- raise ImportError("weasyprint is required for PDF generation. Install with: pip install weasyprint")
-```
-## Output Formats
-### 1. HTML Documentation Sites
-- Responsive design with sidebar navigation
-- Interactive code examples
-- Search functionality
-- Dark/light theme support
-- Mobile-optimized layouts
-### 2. PDF Documentation
-- Professional print-ready formatting
+Generate documentation in multiple formats using established tools: static site generators for HTML, WeasyPrint or Pandoc for PDF, and Markdown for portable content.
+## Static Site Generators
+### Nextra (Next.js)
+Reference Skill("moai-library-nextra") for comprehensive patterns.
+Key features:
+- MDX support for React components in Markdown
+- File-system based routing
+- Built-in search with FlexSearch
+- Theme customization
+- Internationalization support
+Deployment options:
+- Vercel (recommended for Next.js)
+- Netlify
+- GitHub Pages with static export
+### Docusaurus (React)
+Initialize with npx create-docusaurus command.
+Configure docusaurus.config.js:
+- Set site metadata (title, tagline, url)
+- Configure presets for docs and blog
+- Add theme configuration for navbar, footer
+- Enable plugins for search, analytics
+Organize content:
+- Place docs in docs directory
+- Use category.json for sidebar configuration
+- Add versioning for multiple doc versions
+- Configure blog in blog directory
+### VitePress (Vue)
+Initialize with npm init vitepress.
+Configure in .vitepress/config.js:
+- Set site title and description
+- Define navigation and sidebar
+- Configure search (built-in or Algolia)
+- Add social links
+Features:
+- Vue components in Markdown
+- Automatic code syntax highlighting
+- Dark mode support
+- Fast hot module replacement
+### MkDocs with Material
+Install mkdocs-material theme.
+Configure mkdocs.yml:
+- Set theme to material
+- Configure color palette and fonts
+- Enable navigation features (tabs, sections)
+- Add plugins for search, social cards
+Deploy with mkdocs gh-deploy for GitHub Pages.
+## PDF Generation
+### Sphinx PDF Output
+Use sphinx-build with latex builder:
+- Requires LaTeX installation (texlive)
+- Configure latex_documents in conf.py
+- Customize styling with latex_elements
+Alternative with rinohtype:
+- Pure Python PDF generation
+- No LaTeX dependency
+- Configure with rinoh.ini
+### MkDocs PDF Export
+Install mkdocs-pdf-export-plugin.
+Configure in mkdocs.yml:
+- Set combined output option
+- Configure styling
+- Exclude specific pages if needed
+Alternative with mkdocs-with-pdf plugin:
+- Better styling options
+- Cover page support
 - Table of contents generation
-- Code syntax highlighting
-- Header/footer customization
-- Page numbering and bookmarks
-### 3. Static Site Generation
-- Jekyll/Hugo compatible output
-- SEO optimization
-- Fast loading times
-- GitHub Pages deployment
-- Custom domain support
-### 4. Markdown Variants
-- GitHub Flavored Markdown
-- CommonMark compliance
-- Extension support (tables, footnotes)
-- Cross-reference linking
-- Image optimization
-## Template System
-- Jinja2-based templating
-- Customizable themes
-- Component-based design
-- Asset management
-- Multi-language support
-## Integration Points
-- Documentation platforms (GitBook, Docusaurus)
-- CI/CD pipelines
-- Static site hosting
-- Content management systems
-- Version control workflows
+### Pandoc Conversion
+Convert Markdown to PDF with Pandoc:
+- Requires Pandoc and LaTeX installation
+- Use templates for consistent styling
+- Configure with YAML metadata
+Supports multiple input formats:
+- Markdown, reStructuredText
+- HTML, EPUB
+- Word documents
+### WeasyPrint for HTML to PDF
+Convert HTML documentation to PDF:
+- Renders CSS for print media
+- Supports modern CSS features
+- Generates bookmarks from headings
+Configuration options:
+- Custom stylesheets
+- Page size and margins
+- Headers and footers
+## Markdown Output
+### GitHub Flavored Markdown
+Standard for repository documentation:
+- README.md for project overview
+- CONTRIBUTING.md for contribution guidelines
+- CHANGELOG.md for version history
+- docs/ directory for extended documentation
+Features:
+- Tables, task lists, strikethrough
+- Syntax highlighted code blocks
+- Automatic linking for URLs
+- Emoji shortcodes
+### MDX for Component Documentation
+Combine Markdown with JSX:
+- Import and use React components
+- Interactive examples
+- Code playgrounds
+Supported by:
+- Nextra, Docusaurus
+- Storybook for component docs
+- Custom MDX processors
+## Hosting and Deployment
+### GitHub Pages
+Deploy static sites:
+- Configure in repository settings
+- Use GitHub Actions for automation
+- Support custom domains
+### Netlify
+Features:
+- Automatic builds from Git
+- Preview deployments for PRs
+- Form handling, serverless functions
+- Split testing
+### Vercel
+Optimized for Next.js (Nextra):
+- Zero configuration deployment
+- Edge functions
+- Analytics
+- Incremental static regeneration
+### Read the Docs
+Specialized for Sphinx:
+- Automatic versioning
+- PDF generation
+- Search integration
+- Pull request previews
+---
+Version: 2.0.0
+Last Updated: 2025-12-30

moai-adk 0.34.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

moai-adk 0.34.0py3-none-any.whl → 1.1.0py3-none-any.whl