Installation Guide

This guide walks you through installing and setting up EmberDocs for your project.

Prerequisites

Before getting started, ensure you have:

• Node.js 18.0 or higher - Check with node --version
• npm or yarn - Check with npm --version
• Git - For cloning the repository

Installation Steps

1. Clone the Repository

git clone https://github.com/sturdy-barnacle/emberdocs.git
cd emberdocs

2. Install Dependencies

npm install

This will install all required dependencies including Next.js, React, TypeScript, and other core libraries.

3. Configure Environment Variables (Optional)

EmberDocs works with zero configuration, but you can customize branding and behavior:

# Copy the example environment file
cp .env.example .env.local

# Edit .env.local to customize your site
# See user-docs/Setup.md for all available options

Note: If you skip this step, EmberDocs will use sensible defaults. You can always add .env.local later.

4. Start the Development Server

npm run dev

Visit http://localhost:3000 to see your documentation site.

Note: By default, the root route (/) redirects to your documentation index (/docs/index). To show the EmberDocs framework marketing landing page instead, set EMBERDOCS_SHOW_LANDING=true in .env.local.

What's Next?

• Learn about Quick Start for creating your first documents
• Explore Basic Usage to understand how to organize content
• Check Troubleshooting if you hit any issues
• Read the Setup Guide for detailed configuration options

Troubleshooting

Port already in use

If port 3000 is already in use, you can specify a different port:

npm run dev -- -p 3001

Build errors

Clear your Next.js cache and rebuild:

rm -rf .next
npm run build

Missing search index

If search doesn't work, build the search index:

npm run build:search

Note: The search index is automatically built during npm run build, but for development you may need to build it manually after adding new documents.

Environment variables not working

Make sure you:

1. Created .env.local (not .env)
2. Restarted the dev server after editing .env.local
3. Used the correct variable names (check .env.example for reference)