Installation

Get Scholar running on your machine with these simple steps. This guide uses npm, but yarn and pnpm work equally well.

Prerequisites

• Node.js 22.12.0 or higher
• A package manager (npm, yarn, or pnpm)
• A code editor (VS Code recommended)

Quick start

# Clone or copy the theme
git clone https://github.com/example/scholar.git my-docs
cd my-docs

# Install dependencies
npm install

# Start the dev server
npm run dev

Open http://localhost:4321 in your browser. You should see the Scholar homepage.

Build for production

npm run build
npm run preview

The static output is generated in the dist/ directory, ready for deployment to any static host.

Deployment options

Scholar works with all major static hosts:

• Vercel — zero-config deployment
• Netlify — drag-and-drop or Git integration
• Cloudflare Pages — global edge network
• GitHub Pages — free hosting for open source

Troubleshooting

If you encounter issues, ensure your Node.js version meets the minimum requirement. Run node --version to check.