Skip to content

Latest commit

 

History

History
150 lines (103 loc) · 3.6 KB

quick-start.md

File metadata and controls

150 lines (103 loc) · 3.6 KB

Quick Start Guide

Get your documentation generated in just a few steps!

Prerequisites

  • A web browser with internet access
  • Your project information (README file, code snippets, or project overview)
  • Optional: Specific colors or branding preferences

Step-by-Step Guide

Step 1: Prepare Your Input

Gather the information you want DevRead.me to analyze:

  • Your project's README file or description
  • Code snippets or examples (optional)
  • Project overview or technical details
  • Any specific requirements or features

Step 2: Open DevRead.me

Navigate to DevRead.me and you'll see the main generation interface.

Step 3: Enter Your Content

  1. Paste Your Content into the input form

    • Your README content
    • Code snippets
    • Project overview

  2. Review the Default Settings

    • Template style (V1 or V2)
    • Include sidebar option
    • Default color scheme

Step 4: Customize (Optional)

Personalize your documentation:

  • Theme Color - Pick your brand color using the color picker
  • Sidebar - Toggle the navigation sidebar on/off
  • Design Variation - Choose between V1 and V2 designs
  • Documentation Type - Select between full Docsify site or single README.md

Step 5: Generate

Click the "Generate Documentation" button and wait approximately 30 seconds for processing.

You'll see real-time progress as the AI:

  • Analyzes your content
  • Generates comprehensive documentation
  • Creates multiple markdown files
  • Packages everything for deployment

Step 6: Download

Once generation is complete:

  1. Click "Download" to get your ZIP package
  2. The package contains:
    • Complete Docsify documentation site
    • All generated markdown files
    • HTML configuration files
    • CSS styling

Step 7: Deploy

Extract your ZIP file and deploy to your preferred platform:

GitHub Pages

# Push the contents to your gh-pages branch
git checkout gh-pages
# Copy the documentation files
# Commit and push
git push origin gh-pages

Vercel

  • Connect your GitHub repository
  • Select the deployment folder
  • Vercel automatically deploys

Netlify

  • Drag and drop your extracted folder to Netlify
  • Or connect your GitHub repository
  • Auto-deploys on changes

Other Hosting

  • Upload the extracted files to any static hosting service
  • No backend or server configuration needed

Tips for Best Results

  1. Quality Input - Provide clear, detailed project information
  2. Complete Information - Include setup steps, features, and API details
  3. Code Examples - Include code snippets for better documentation
  4. Specific Focus - Be clear about what your project does

Common Use Cases

For a New Project

- Project description
- Main features list
- Quick setup instructions
- Basic usage examples

For an Existing Project

- Existing README.md
- Code structure overview
- Installation instructions
- API endpoints or main classes

For API Documentation

- API endpoints list
- Method descriptions
- Parameter information
- Response examples

Next Steps

Need Help?

Happy documenting! Your professional documentation is just 30 seconds away! 🚀