Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.35 KB

README.md

File metadata and controls

70 lines (44 loc) · 2.35 KB

Mintlify Starter Kit

Use the starter kit to get your docs deployed and ready to customize.

Click the green Use this template button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with

  • Guide pages
  • Navigation
  • Customizations
  • API reference pages
  • Use of popular components

Follow the full quickstart guide

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

Test coverage data

testing/test-coverage.mdx is built from the Jenkins E2E artifact. To refresh it before dev or deploy:

npm run update-test-coverage

npm run dev runs this fetch first (with --keep-on-error); if the fetch fails, the existing test-coverage.mdx is left unchanged. Data is fetched from:

https://jenkins.justcall.io/job/e2e-jobs/job/e2e-smoke/job/e2e-do-not-edit-disable/lastSuccessfulBuild/artifact/test-coverage.json

If the artifact requires Jenkins login, set these before running (or in CI secrets):

  • JENKINS_USER (or JENKINS_USERNAME) – your Jenkins username
  • JENKINS_TOKEN (or JENKINS_API_TOKEN) – API token from Jenkins → your user → Configure → Add new Token

Example (do not commit real values):

export JENKINS_USER=your-username
export JENKINS_TOKEN=your-api-token
npm run update-test-coverage

With a .env file (Node 20.6+): node --env-file=.env scripts/fetch-test-coverage.mjs. In CI, set JENKINS_USER and JENKINS_TOKEN as repository secrets.

Publishing changes

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

Need help?

Troubleshooting

  • If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
  • If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

Resources