Creating Projects

Learn how to create and manage documentation projects in ezDoc.

Creating a New Project

From the Welcome Screen

1. Click "Create New Project"
2. Select a folder location on your computer
3. Enter a project name
4. Click "Create Project"

Project Folder Structure

ezDoc creates this structure:

my-project/
├── ezdoc.json              # Project configuration
├── pages/                  # Your documentation pages
│   ├── page-1.md
│   └── page-2.md
├── assets/                 # Images and files
│   └── images/
└── .ezdoc/                 # Internal metadata
    └── navigation.json     # Navigation structure

Opening an Existing Project

From the Welcome Screen

1. Click "Open Existing Project"
2. Navigate to your project folder
3. Select the folder
4. Click "Select Folder"

From Within a Project

1. Click the ezDoc logo in the top-left
2. Select "Open Project"
3. Choose your project folder

Project Settings

Accessing Settings

1. Open your project
2. Click the ⚙️ Settings button in the sidebar

Available Settings

Project Title

• Custom title for your documentation
• Appears in exported site headers
• Defaults to project folder name

Layout

Choose how navigation appears:

• Left Navigation (default)
• Right Navigation
• Top Navigation

Theme

• System - Matches your OS theme
• Light - Always light mode
• Dark - Always dark mode

Auto-Save

• Enabled - Saves automatically every 30 seconds
• Disabled - Manual save only

Home Link

• Show - Display home link in navigation
• Hide - No home link

Project Configuration File

The ezdoc.json file stores your project settings:

{
  "name": "My Documentation",
  "version": "1.0.0",
  "projectTitle": "My Docs",
  "layout": "left-nav",
  "theme": "system",
  "preferences": {
    "autoSave": true,
    "autoSaveInterval": 30000,
    "showHomeLink": true
  },
  "pages": [...]
}

Multiple Projects

You can create and manage multiple projects:

1. Each project is independent
2. Switch between projects anytime
3. No limit on number of projects
4. Projects can be anywhere on your computer

Project Backup

Manual Backup

Simply copy your project folder:

my-project/  →  my-project-backup/

Version Control

ezDoc projects work great with Git:

cd my-project
git init
git add .
git commit -m "Initial documentation"

Sharing Projects

Share the Folder

Zip your project folder and share:

my-project.zip

Recipients can open it in ezDoc.

Share Exported Site

Export your project and share the HTML files:

1. Export project
2. Zip the export folder
3. Share or host on any web server

Deleting Projects

ezDoc doesn't delete project folders. To remove a project:

1. Close ezDoc
2. Delete the project folder from your file system

Backup & Restore Projects

What Gets Stored

ezDoc stores your project list to: Documents\ezDoc\Settings\projects.json

Projects are discovered by scanning the Documents\ezDoc\Projects\ folder - each subfolder with a valid .ezdoc/config.json is recognized as a project

Backing Up Your Projects

Protect your project list from data loss:

1. Click the "Backup" button on the main screen
2. A JSON file downloads automatically
3. Store it safely (cloud storage, external drive)

Backup file name: ezdoc-backup-YYYY-MM-DD.json

Restoring Projects

If you lose your project list (cleared browser data, new computer):

1. Click the "Restore" button on the main screen
2. Select your backup JSON file
3. Review the confirmation dialog
4. Click "Restore"
5. Projects reappear in your list!

The backup file only contains your project list metadata. Your actual project files (pages, images, etc.) are always safe on your file system.

Best Practices

Naming Projects

• Use descriptive names
• Avoid special characters
• Keep names short and clear

Organization

• One project per documentation set
• Use categories within projects
• Keep related content together

File Management

• Store images in assets/images/
• Use relative paths for portability
• Keep file names simple