Skip to main content

​
Prerequisites

Install Node.js

  • Download and install Node.js
  • Recommended version: 16.x or higher
  • Install Git for version control
  • Required for cloning the repository

​
Getting Started

1

Install Mintlify CLI

Install the Mintlify CLI globally using npm:
npm i -g mintlify
2

Clone the Repository

Clone your documentation repository:
git clone https://github.com/blinko-space/blinko-docs
cd blinko-docs
3

Start Development Server

Run the development server in your documentation root:
mintlify dev
The documentation will be available at http://localhost:3000

​
Making Changes

Edit Content

  • Modify .mdx files in your repository
  • Changes will hot-reload in the browser
  • Use Markdown and MDX components
  • Place images in the /images directory
  • Reference them using relative paths:
<img src="/images/example.png" />
  • Edit mint.json to modify navigation structure
  • Update page metadata in MDX files

​
Troubleshooting

Common issues and solutions:
  • If mintlify dev fails, try mintlify install to reinstall dependencies
  • Ensure you’re in the correct directory with mint.json
  • Clear your browser cache if changes aren’t reflecting
Always commit your changes to version control:
git add .
git commit -m "Update documentation"
git push

​
Deployment

Changes will automatically deploy when pushed to your default branch if you have configured the Mintlify GitHub App.
For optimal deployment:
  • Test all changes locally first
  • Ensure all images and links work
  • Verify navigation structure