Brendan O'Leary 29f43386cb Breadcrumbs component 4 days ago
..
.kilocode e2909f2194 Replace docs with new Markdoc site 2 weeks ago
__tests__ c14c12a9ff test: add redirect loop detection test for docs 2 weeks ago
components 29f43386cb Breadcrumbs component 4 days ago
docs 1679c5bb40 add cline docs (#5500) 2 weeks ago
lib 20b095feb1 docs: add 'Using Kilo for Free' documentation page 1 week ago
markdoc e2909f2194 Replace docs with new Markdoc site 2 weeks ago
pages 1318f01ed8 Add breadcrumbs to the docs 4 days ago
public 3ad6a06a73 Update some syntax errors and missing images (#5637) 4 days ago
.env.docs.sample 2c6d8e6917 Add posthog to docs site 2 weeks ago
.gitattributes e2909f2194 Replace docs with new Markdoc site 2 weeks ago
.gitignore 0581c21db2 Ignore docs auto types 2 weeks ago
AGENTS.md a9a46321bc Merge pull request #5593 from Kilo-Org/bdo/docs-prefix-note 1 week ago
README.md 817c33f066 For docs only changes, request a docs/ branch name 1 week ago
instrumentation-client.ts 2c6d8e6917 Add posthog to docs site 2 weeks ago
mappingplan.md 5e4348dc36 Merge branch 'main' into mark/removememorybank 1 week ago
next.config.js 7a8c040971 Add basepath of docs 2 weeks ago
package.json c14c12a9ff test: add redirect loop detection test for docs 2 weeks ago
postcss.config.js e2909f2194 Replace docs with new Markdoc site 2 weeks ago
previous-docs-redirects.js 5e4348dc36 Merge branch 'main' into mark/removememorybank 1 week ago
tailwind.config.js e2909f2194 Replace docs with new Markdoc site 2 weeks ago
tsconfig.json e2909f2194 Replace docs with new Markdoc site 2 weeks ago
vitest.config.ts c14c12a9ff test: add redirect loop detection test for docs 2 weeks ago

README.md

Full Next.js example

This is a full-featured boilerplate for a creating a documentation website using Markdoc and Next.js.

image

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 with Vercel

Deploy to Netlify

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-tutorial
  • docs/fix-installation-steps
  • docs/update-api-reference

For full contribution guidelines, see the Contributing Guide.