Quick start
This tutorial walks you from installing the CLI to deploying a DevDocify site. It takes about ten minutes.
What you'll build
A new documentation site running locally, with content validation and broken-link checks passing, ready to deploy to Vercel.
Prerequisites
- Node.js 20.17.0 or later (includes npm)
- A GitHub account (for deployment)
- A Vercel account (for deployment)
Step 1: Install the CLI
Install the Docify CLI globally:
npm install -g @devdocify/cli
Confirm it's available:
docify --version
Step 2: Create a project
Scaffold a new DevDocify project in a directory called my-docs:
docify new my-docs
Change into the new directory and install dependencies:
cd my-docs
npm install
Step 3: Start the dev server
docify dev
Open http://localhost:3000 in your browser. You should see your new docs site.
Edit docs/index.md and save. The browser should reload automatically.
Press Ctrl+C to stop the dev server when you are done.
Step 4: Validate content
Run the content linter to catch common issues before you build:
docify validate
If your package.json doesn't have a lint-content script yet, add one:
"lint-content": "echo \"No linter configured\""
Step 5: Check for broken links
Build the site and check every internal link:
docify broken-links
Fix any broken links reported before continuing.
Step 6: Build and deploy
Build a production bundle:
docify build
Deploy to Vercel:
- Push your project to a GitHub repository.
- Log in to vercel.com and click Add New Project.
- Import your GitHub repository.
- Set the following in Vercel project settings:
| Setting | Value |
|---|---|
| Build command | npm run build |
| Output directory | build |
| Install command | npm install |
- Click Deploy.
Vercel runs a build on every push to main and creates preview deployments for every pull request.