- Install homebrew (https://brew.sh/)
- Install node and npm
- Git clone this repository (
git@github.com:planetscale/docs.planetscale.com.git
)
- Switch to repository's folder
- Install package dependencies with
npm install
- Execute
npx next dev
or npm run develop
to start a local nextJS server
- Access development server at
http://localhost:3000
. Check terminal to find the actual port being used by your nextJS local server.
- All pages in the documentation are markdown (.mdx) files with a frontmatter block on the top. The frontmatter block defines the title and (optionally) a subtitle and/or banner for the page.
- When creating a new document, also create a corresponding entry in
meta.json
to define the category and position of the document's link in the navigation list.
- Search is powered by DocSearch. PlanetScale's configuration on DocSearch can be viewed here
- Sitemap is only generated during a build and is not checked in to the repo.