Skip to content

install.md

Latest commit

 

History

History
32 lines (20 loc) · 879 Bytes

install.md

File metadata and controls

32 lines (20 loc) · 879 Bytes

install.md Documentation

A specification for human-readable, AI-executable installation instructions.

This is a meta example - the install.md file for the install.md documentation site itself!

Clone the repository and set up the local development environment:

git clone https://github.com/mintlify/install-md.git
cd install-md

Check if I have Node.js 18+ installed. If not, install it using my system's package manager (brew, apt, dnf, etc.) or from nodejs.org.

Install the Mintlify CLI globally:

npm install -g mint

Start the development server:

mint dev

This will start a local server at http://localhost:3000 where I can preview the documentation.

Tell me the URL and that the preview will automatically update as I edit files.

Optional: If I want to contribute, create a new branch for my changes before editing any files.