Skip to content

antimetal/mintlify-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Antimetal Docs

Documentation for Antimetal, powered by Mintlify.

Development

Requires Node 22.

Install dependencies:

npm install

Start the local preview (fetches the latest OpenAPI spec, converts it, and starts the dev server):

npm run dev

Preview at http://localhost:3000.

NPM scripts

Script Description
npm run dev Fetch OAS, convert it, and start mint dev
npm run fetch:oas Pull the latest OpenAPI YAML from Stainless into assets/openapi.with-code-samples.yml
npm run mintlify:oas Convert the YAML to a Mintlify-compatible JSON at assets/openapi.mintlify.json

API reference

The API reference tab is auto-generated from assets/openapi.mintlify.json. To update it, run npm run fetch:oas && npm run mintlify:oas (or just npm run dev).

The conversion script (scripts/mintlify-oas.js) patches JSON Schema draft-07 constructs that Mintlify's validator doesn't support.

Deployment

Changes pushed to the default branch deploy automatically via the Mintlify GitHub app.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Generated from mintlify/starter