Jean du Plessis
e55612d62c
Merge pull request #5961 from Olusammytee/docs/2165-clean-shell-integration-page
|
3 ساعت پیش | |
|---|---|---|
| .. | ||
| .kilocode | 3 هفته پیش | |
| __tests__ | 3 هفته پیش | |
| components | 20 ساعت پیش | |
| docs | 1 هفته پیش | |
| lib | 3 ساعت پیش | |
| markdoc | 3 هفته پیش | |
| pages | 3 ساعت پیش | |
| public | 3 ساعت پیش | |
| .env.docs.sample | 3 هفته پیش | |
| .gitattributes | 3 هفته پیش | |
| .gitignore | 3 هفته پیش | |
| AGENTS.md | 1 روز پیش | |
| README.md | 2 هفته پیش | |
| instrumentation-client.ts | 3 هفته پیش | |
| mappingplan.md | 2 هفته پیش | |
| next.config.js | 3 هفته پیش | |
| package.json | 3 هفته پیش | |
| postcss.config.js | 3 هفته پیش | |
| previous-docs-redirects.js | 4 ساعت پیش | |
| tailwind.config.js | 3 هفته پیش | |
| tsconfig.json | 3 هفته پیش | |
| tsconfig.tsbuildinfo | 6 روز پیش | |
| vitest.config.ts | 3 هفته پیش | |
README.md
Full Next.js example
This is a full-featured boilerplate for a creating a documentation website using Markdoc and Next.js.
Setup
First, clone this repo and install the dependencies required:
npm install
# or
yarn install
Then, run the development server:
npm run dev
# or
yarn dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying index.md. The page auto-updates as you edit the file.
Deploy
The quickest way to deploy your own version of this boilerplate is by deploying it with Vercel or Netlify by clicking one of the buttons below.
Deploy with Vercel
Deploy to Netlify
Contributing
When making documentation only changes, use branch names prefixed with docs/:
git checkout -b docs/your-change-description
Examples:
docs/add-mcp-tutorialdocs/fix-installation-stepsdocs/update-api-reference
For full contribution guidelines, see the Contributing Guide.