Frequently Asked Questions
Common questions about ezDoc.
General Questions
What is ezDoc?
Use ezDoc to create beautiful, production-ready help sites without configuration headaches.
Is ezDoc free?
ezDoc has a freemium model:
- Free Version: 2 projects, all core features, branded footer
- Professional: 6 projects, footer customization, priority support
- Commercial: Unlimited projects, full customization, commercial use
The free version is fully functional for personal use!
Do I need an account?
No account required. Start using ezDoc immediately.
Does ezDoc work offline?
Yes! Once loaded, ezDoc works completely offline. Your data never leaves your computer.
Where is my data stored?
All data is stored locally on your computer in the Documents\ezDoc\ folder:
- Projects -
Documents\ezDoc\Projects\[ProjectName]\ - Settings -
Documents\ezDoc\Settings\projects.json - Templates -
Documents\ezDoc\Templates\ - Exports -
Documents\ezDoc\Exports\
Nothing is sent to any server. Your data never leaves your computer.
Technical Questions
Do I need to install anything?
No installation required. Just run ezDoc.
Can I use ezDoc on mobile?
No ezDoc is optimized for Windows desktop.
Does ezDoc require internet?
No
What file formats does ezDoc support?
- Markdown (.md)
- HTML (.html)
- Images (JPG, PNG, GIF, SVG, WebP)
Features Questions
Can I add images?
Yes! Use the Insert Image button to upload and manage images.
Can I use custom CSS?
Yes, in HTML mode you can add custom styles.
Does ezDoc support code highlighting?
Yes! Code blocks automatically get syntax highlighting.
Can I organize pages into categories?
Yes! Create categories with custom icons and colors.
Can I export my documentation?
Yes! Export to static HTML that works anywhere.
Does the exported site need a server?
No! Exported sites are static HTML and work without a server.
Usage Questions
How many projects can I create?
Depends on your license:
- Free: 2 projects
- Professional: 6 projects
- Commercial: Unlimited projects
Projects beyond your limit are hidden but remain on disk. Upgrade to access them!
How do I create a new project?
Click "Create New Project", enter a name, and click Create. Projects are automatically saved to Documents\ezDoc\Projects\[ProjectName]\.
How do I add a new page?
Click the "+ New Page" button in the sidebar.
How do I save my work?
ezDoc auto-saves every 30 seconds. You can also manually save with Ctrl+S.
How do I preview my pages?
Click the "👁 Preview" button in the toolbar.
How do I export my documentation?
Click the "📤 Export Project" button and choose an export location.
Can I change the theme?
Yes! Choose between System, Light, or Dark in project settings.
Can I change the layout?
Yes! Choose between Left Nav, Right Nav, or Top Nav in project settings.
Content Questions
Should I use Markdown or HTML?
- Markdown: Simpler, faster, good for most content
- HTML: More control, complex layouts, custom styling
Can I mix Markdown and HTML?
Yes! You can use HTML tags in Markdown pages.
How do I add links?
Use the link button or Markdown syntax: [Text](url)
How do I add code blocks?
Use triple backticks in Markdown:
```javascript
code here
```
Can I add tables?
Yes! Use Markdown table syntax or HTML tables.
Can I use voice typing?
Yes! Click the 🎤 microphone button or press Win+H to use Windows voice typing. Great for hands-free documentation!
How do I insert tree diagrams?
Click the ├─ button in the toolbar to:
- Insert individual tree characters (
├──,│,└──) - Generate a complete folder tree template
Perfect for showing file structures!
Export Questions
Can I customize the footer?
Free version: Footer shows "Generated with ezDoc Studio" (required)
Registered version: Full control - customize text, add links, or remove footer entirely. Supports HTML for professional branding.
Where do exported files go?
To the folder you choose during export.
Can I host exported sites?
Yes! Exported sites are static HTML and work on any web server:
Free Hosting:
- GitHub Pages
- Netlify
- Vercel
- Cloudflare Pages
Paid Hosting:
- Your own web server
- Shared hosting (cPanel, etc.)
- Cloud hosting (AWS S3, Azure, etc.)
Just upload the exported folder via FTP, Git, or hosting dashboard!
Do exported sites work offline?
Yes! Exported sites are completely self-contained and work:
- Offline (open index.html locally)
- On any web server
- Without databases or backend
Can I customize exported sites?
Yes! Edit the exported HTML/CSS files directly. All files are standard HTML/CSS/JS with no build process required.
How do I update an exported site?
- Make changes in ezDoc
- Export again to the same folder (or new folder)
- Upload/replace files on your server
- Changes are live!
Troubleshooting Questions
Why aren't my images showing?
- Check images are in
assets/images/ - Verify relative paths
- Ensure images were uploaded
Why is the export failing?
- Check folder permissions
- Ensure disk space available
- Try a different export location
Why is ezDoc slow?
- Optimize large images
- Reduce page count
- Clear browser cache
- Close other tabs
Data & Storage Questions
What happens if I clear my browser data?
Nothing! Your projects are stored on disk in Documents\ezDoc\Projects\, not in the browser. Clearing browser data won't affect your projects.
How do I backup my projects?
Your projects are automatically stored in Documents\ezDoc\Projects\. To backup:
Copy the entire ezDoc folder from Documents to:
- External drive
- Cloud storage (Dropbox, OneDrive, etc.)
- Network location
Or backup individual projects by copying their folders from
Documents\ezDoc\Projects\[ProjectName]\
What's in a project folder?
Each project folder contains:
ezdoc.json- Project configurationpages/- All your documentation pages (.md or .html files)assets/images/- Uploaded imagescategories.json- Category organization
Can I move ezDoc to another computer?
Yes! It's easy:
- Copy the ezDoc folder from
Documents\ezDoc\on old computer - Paste it to
Documents\ezDoc\on new computer - Open ezDoc - Projects are automatically discovered!
That's it! No backup/restore needed since projects are stored on disk.
Privacy & Security Questions
Is my data private?
Yes! All data stays on your computer. Nothing is sent to any server.
Can others access my projects?
Only if they have access to your computer and the project folders.
Is ezDoc secure?
Yes! No data transmission, no tracking, no accounts.
Can I use ezDoc for sensitive documentation?
Yes! Since everything is local, it's as secure as your computer.
Comparison Questions
How is ezDoc different from other tools?
- Local-first: No cloud, no servers
- Free: No subscriptions
- Simple: Easy to use
- Portable: Works anywhere
Can I migrate from other tools?
Yes! Copy your content into ezDoc pages.
Can I export to other formats?
Currently exports to HTML. Other formats may be added in the future.