Welcome to SmartGen Docs

Welcome to the official documentation for SmartGen Docs, a lightweight, open-source static site generator designed specifically for project documentation. Built by Sayad Md Bayezid Hosan for the Smartgen Platform, it offers a simple yet powerful way to transform Markdown files into elegant, responsive documentation websites.

SmartGen Docs empowers developers and technical writers to create, manage, and deploy professional-grade documentation with ease, allowing you to focus on content while the platform handles the presentation. This documentation will guide you through every aspect of using SmartGen Docs, from initial setup to advanced customization and deployment.

Key Features

SmartGen Docs is packed with features designed to streamline your documentation workflow:

• Markdown-Centric: Write your documentation in clean, easy-to-read Markdown, leveraging familiar syntax for headings, lists, code blocks, and more.
• Static Site Generation: Generates a complete static HTML website, ensuring fast loading times, enhanced security, and easy deployment on any web server or hosting service.
• YAML Configuration: Utilize a simple smartgen.yml file for straightforward project configuration, navigation definition, and theme customization.
• Live Reload Development Server: Develop your documentation with a built-in server that automatically reloads changes as you save, providing an efficient and responsive development experience.
• Customizable Themes: Easily extend and customize the look and feel of your documentation using Jinja2 templates and standard CSS, allowing for brand consistency and unique aesthetics.
• Command-Line Interface (CLI): An intuitive CLI provides commands for building, serving, initializing new documentation projects, and performing other essential tasks.
• API Auto-Generation: Generate API references directly from your Python docstrings, ensuring your API documentation is always up-to-date with your codebase.
• Upload Manager: A built-in web interface for non-technical content management, simplifying the process of adding and updating documentation files.

Get Started in Seconds

Ready to create your first documentation site? Follow our quick guide to get up and running:

1. Installation: Learn how to install SmartGen Docs on your system. Read the Installation Guide
2. Quick Start: Dive into a step-by-step tutorial to create your first project. Explore the Quick Start Guide
3. First Project: Understand the basic structure and how to add your content. Learn about Your First Project

Explore the Documentation

Navigate through the sections below to find detailed information on specific topics:

• Getting Started: Comprehensive guides for setting up and beginning your SmartGen Docs project.
• Documentation: Understand the core concepts, architecture, and features of SmartGen Docs.
• API Reference: Detailed documentation for interacting with the SmartGen Docs API.
• SDKs: Language-specific guides and examples for integrating SmartGen Docs into your applications.
• SmartGen Tools: Discover the various tools provided by the SmartGen Platform.
• Tutorials: Step-by-step instructions for common tasks and advanced use cases.
• Guides: Best practices, customization options, and troubleshooting tips.
• Resources: Supplementary materials, including downloads, templates, and a glossary.
• Community: Information on how to contribute, report issues, and engage with the SmartGen Docs community.
• Blog: Stay updated with the latest news, articles, and release notes.
• About: Learn more about the SmartGen Docs project and its creator.

SmartGen Docs is an open-source project. We welcome contributions from the community. If you have suggestions, bug reports, or would like to contribute code, please visit our GitHub Repository and review our Contributing Guidelines.