Step 1: Create Your First Project

Prerequisites

  • Node.js 18+
  • npm

Commands

mkdir my-shevky-site
cd my-shevky-site
npm init -y
npm install @shevky/core @shevky/plugin-robots-txt @shevky/plugin-tailwindcss @shevky/plugin-esbuild @shevky/plugin-rss @shevky/plugin-sitemap
npx shevky --init

Expected Output

After these commands complete:

  • package.json has build and dev scripts added automatically.
  • src/ directory is created with starter content, templates, layouts, and components.
  • tailwind.config.js is copied to the project root.
  • .gitignore includes node_modules/ and dist/.

What Just Happened

  • You installed the Shevky CLI (@shevky/core) and baseline build plugins.
  • The --init flag triggered core/scripts/init.js, which cloned a starter template via degit from fatihtatoglu/shevky-simple-blog.
  • Starter files were copied into your project and npm scripts were configured.
  • Your project now matches Shevky's expected runtime structure.

Common Errors

ErrorFix
package.json not found during initEnsure npm init -y ran in the same folder
Init fails with network/degit errorsCheck internet connectivity and retry
Missing plugin packages later at buildRe-run the npm install ... command above

Related