Install VS CodeRecommended
Install Visual Studio Code, the recommended editor for writing and managing your CamelMind documentation.
While you can write CamelMind documentation in any text editor, Visual Studio Code (VS Code) offers the best experience. It is free, beginner-friendly, and works great with Markdown, MDX, and other CamelMind files.
You do not need any programming experience to use VS Code—it provides a place to edit your documentation and run terminal commands.
Why choose VS Code for CamelMind documentation
VS Code simplifies writing documentation by offering:
- Syntax highlighting for Markdown, MDX, YAML, and TypeScript
- An integrated terminal for running CamelMind commands without leaving the editor
- File Explorer for browsing your documentation files
- Project-wide search for finding and updating content
- Thousands of extensions for customizing your editing experience
If you already use another editor such as WebStorm, Zed, Sublime Text, or Vim, feel free to stick with it. CamelMind works with any text editor because your documentation consists of standard plain-text files.
Installing VS Code on your operating system
Select your operating system below to install Visual Studio Code:
Download VS Code directly from code.visualstudio.com, or install it using Homebrew:
brew install --cask visual-studio-code
Download VS Code from code.visualstudio.com and run the setup wizard using default settings.
Download the appropriate package from code.visualstudio.com, or install it using your distribution's package manager.
Recommended extensions for CamelMind
After installing VS Code, open the Extensions view (Cmd+Shift+X on macOS or Ctrl+Shift+X on Windows/Linux) and install these recommended extensions:
| Extension | Why |
|---|---|
| MDX | Provides syntax highlighting and formatting for .mdx files. |
| YAML | Provides validation and autocomplete for nav/nav.yml. |
VS Code includes an integrated terminal. Press Ctrl+` (or Control+` on macOS) to open the terminal and execute commands such as npm install and npm run dev without switching applications.
Learning Markdown and MDX basics
CamelMind authors write pages using MDX, which combines standard Markdown syntax with interactive components such as <Callout> and <Steps>.
If you have never written Markdown before, do not worry—you can learn it. Follow the Writing Content guide after setting up your first site.
Next step: Proceed to Node.js installation
Now that you have configured your text editor, continue to the Install Node.js guide if you have not installed it already. Once complete, you can proceed directly to create your first CamelMind site.