Exporting Documentation

Export your documentation as a self-contained static website that works anywhere.

How to Export

1. Click the 📤 Export Project button
2. Choose an export location folder
3. Wait for the export to complete
4. View the success dialog

Export Process

Progress Dialog

During export, you'll see:

• Current step being processed
• Progress bar
• List of completed steps

Steps Performed

1. Creating export structure
2. Loading pages
3. Generating index page
4. Generating individual pages
5. Copying assets (images, files)

What Gets Exported

File Structure

export-folder/
├── index.html              # Home page
├── pages/                  # All documentation pages
│   ├── page-1.html
│   ├── page-2.html
│   └── ...
└── assets/                 # Images and files
    └── images/
        ├── image1.png
        └── ...

Features Included

• ✅ All pages converted to HTML
• ✅ Navigation with categories
• ✅ Theme switching (light/dark)
• ✅ Syntax highlighting
• ✅ Responsive design
• ✅ All images and assets
• ✅ Search functionality (coming soon)

Viewing Exported Site

Local Viewing

1. Open the export folder
2. Double-click index.html
3. Browse your documentation

Web Server

For best results, use a local web server:

# Python
python -m http.server 8000

# Node.js
npx http-server

# PHP
php -S localhost:8000

Then visit: http://localhost:8000

Deploying to Web

Static Hosting Services

Upload your export folder to:

• Netlify - Drag and drop deployment
• Vercel - Git-based deployment
• GitHub Pages - Free hosting
• AWS S3 - Scalable hosting
• Any web server - Upload via FTP

Deployment Steps

1. Export your project
2. Zip the export folder (optional)
3. Upload to your hosting service
4. Configure domain (if needed)

Example: Netlify

1. Go to netlify.com
2. Drag export folder to deploy
3. Get instant URL
4. Configure custom domain

Example: GitHub Pages

cd export-folder
git init
git add .
git commit -m "Documentation"
git remote add origin <your-repo>
git push -u origin main

Enable GitHub Pages in repository settings.

Export Settings

Layout Options

Choose in project settings:

• Left Navigation - Sidebar on left
• Right Navigation - Sidebar on right
• Top Navigation - Horizontal menu

Theme Options

• System - Matches user's OS theme
• Light - Always light mode
• Dark - Always dark mode

Project Title

Set a custom title in project settings. This appears in:

• Browser tabs
• Page headers
• Navigation

Exported Site Features

Responsive Design

Works on all devices:

• Desktop computers
• Tablets
• Mobile phones

Theme Switching

Users can toggle between light and dark modes using the theme button in the header.

Navigation

• Clickable sidebar/top menu
• Category organization
• Active page highlighting
• Home link (optional)

Code Highlighting

Code blocks automatically get syntax highlighting with Highlight.js.

Offline Capable

Exported sites work completely offline - no internet required!

Re-Exporting

To update your deployed documentation:

1. Make changes in ezDoc
2. Export again to the same folder
3. Upload updated files
4. Changes are live!

Export Best Practices

Before Exporting

• ✅ Preview all pages
• ✅ Check for broken links
• ✅ Verify images load
• ✅ Test on mobile
• ✅ Review navigation

File Management

• Use descriptive export folder names
• Keep exports organized
• Version your exports (v1, v2, etc.)

Testing

After export:

• Open in different browsers
• Test all links
• Verify images
• Check mobile view
• Test theme switching

Troubleshooting

Images Not Showing

• Ensure images are in assets/images/
• Check image paths are relative
• Verify images were copied

Broken Links

• Use relative links
• Don't link to external pages
• Test all internal links

Export Limitations

No Server-Side Features

Exported sites are static HTML:

• No databases
• No user authentication
• No server-side processing

File Size

Large projects may take time to export. Be patient during the process.

---