Getting Started — Docsframe

Create project

We recommend that you create a Next.js project using the shadcn/ui CLI

npx shadcn@latest init

You can use the -d flag for defaults i.e new-york, zinc and yes for the css variables.

npx shadcn@latest init -d

Initialize Docsframe

Run the init command to setup Docsframe to your project:

npx docsframe@latest init

That's it

You are now ready to customize Docsframe and start building your documentation. For more information on configuring new documentation pages, please refer to the docsframe.json.

Add components

Use the add command to add components to your project.

npx docsframe@latest add [component]

Options

Usage: docsframe add [options] [components...]
 
add docsframe components to your documentation
 
Arguments:
  components                     the components to add
 
Options:
  -o, --overwrite                overwrite existing files
  -c, --cwd [cwd]                the working directory. defaults to the standard docsframe directory.
  --skip-deps                    skip dependency installation