ReadMe

Local Development

Step 1: Install Node.js, npm, Mintlify

sudo apt-get install nodejs
sudo apt-get install npm
npm install -g minify

Step 2: Start Development Server

--port: Specify the port number to run the server. Default is 3000.

mintlify dev

use npx if you don't have mintlify installed

npx mintlify dev

디렉토리 구조

To use components, use the MDX file extension. Components are only available for components that are supported by mintlify.

gitbook에서 기능	디렉토리 경로
Space	./spaces/[space-name]
Page Group	./spaces/[space-name]/[group-name]
Page	./spaces/[space-name]/[group-name]/[page-name].mdx

Mintlify Components

components docs

Callout

Note

<Note>This adds a note in the content</Note>

Warning

<Warning>This raises a warning to watch out for</Warning>

Info

<Info>This draws attention to important information</Info>

Tip

<Tip>This suggests a helpful tip</Tip>

markdownlint

markdownlint is a linter for markdown,mdx files. It is used to ensure that the markdown files are consistent and follow best practices.

bold-parentheses-space custom role is used to force a space after bold text that contains parentheses. This is a way to get around the limitation that the Markdown syntax does not allow the use of parentheses inside bold text.

**(this is bold)**this is not bold
**(this is bold)** this is bold

• custom rules guide