The fastest way to create a new Specra documentation site. Scaffold a complete documentation project with a single command.
npx create-specra my-docsnpm create specra my-docsyarn create specra my-docspnpm create specra my-docsnpx create-specra [project-directory] [options][project-directory]- The directory to create the project in (optional, will prompt if not provided)
--template <template>- Template to use:minimal(will prompt if not provided)--use-npm- Use npm as the package manager--use-pnpm- Use pnpm as the package manager--use-yarn- Use yarn as the package manager--skip-install- Skip package installation
Minimal setup to get started quickly:
- Basic documentation structure
- Essential configuration
- Clean starting point
- Ready to customize
Create a new project with interactive prompts:
npx create-specraCreate a project with the minimal template using npm:
npx create-specra my-docs --template minimal --use-npmCreate a project and skip installation:
npx create-specra my-docs --skip-installThe CLI creates a new Next.js project with Specra pre-configured:
my-docs/
├── app/
│ ├── layout.tsx
│ ├── page.tsx
│ └── [...slug]/
│ └── page.tsx
├── docs/
│ └── v1.0.0/
│ └── index.mdx
├── public/
├── specra.config.ts
├── next.config.js
├── tailwind.config.ts
└── package.json
Once your project is created, you can:
-
Start the development server:
cd my-docs npm run dev -
Open http://localhost:3000 in your browser
-
Edit your documentation in the
docs/directory -
Customize your site in
specra.config.ts
Specra is a modern documentation library for Next.js that provides:
- Multi-version documentation support
- API reference generation
- Full-text search
- MDX-powered content
- Beautiful UI components
MIT
dalmasonto, arthur-kamau