Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.27 KB

running-locally.md

File metadata and controls

32 lines (24 loc) · 1.27 KB
Raw

Run a local copy of the docs site

⚠️ To run a local copy of the docs site, you must have access to https://github.com/meilisearch/meilisearch.com/. You must also be a member of Meilisearch's team on Vercel. If you are Meilisearch employee and don't have access to either of them, contact your manager.

Requirements

  • Node.js v18.x
  • Yarn
  • Vercel CLI: yarn global add vercel

Running a local copy of the docs

By default, this will use the content at the tip of the main branch:

  1. Clone the meilisearch.com repository: git clone [email protected]:meilisearch/meilisearch.com.git
  2. Move into the local copy of the cloned repository: cd meilisearch.com
  3. Check you are using Node.js v18.x
  4. Install dependencies: yarn install
  5. Link Vercel
    1. vercel link
    2. Follow instructions to link a Vercel account with access to Meilisearch team
    3. Choose existing project when requested
    4. project name: website
  6. Fetch config files: vercel env pull
  7. Run local server: yarn dev and point web browser to localhost:3000/docs

Using a different branch

  1. Open /src/lib/docs/constants.ts
  2. Search for BRANCH = 'main'
  3. Change main to the specific remote branch you're targeting
  4. Relaunch local server and point web browser to localhost:3000/docs