This is what an AI/RAG pipeline sees when it indexes this page — the same output served at https://camelmind-docs.vercel.app/api/llms/before-you-begin/install-vscode.Back to doc

Rendered doc

Install VS Code

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:

bash
brew install --cask visual-studio-code

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:

ExtensionWhy
MDXProvides syntax highlighting and formatting for .mdx files.
YAMLProvides validation and autocomplete for nav/nav.yml.
Tip

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.

What the AI sees

1> For a complete documentation index, see /llms.txt. To read any public page as Markdown, append .md to the URL.
2 
3While 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.
4 
5You do not need any programming experience to use VS Code—it provides a place to edit your documentation and run terminal commands.
6 
7---
8 
9## Why choose VS Code for CamelMind documentation
10 
11VS Code simplifies writing documentation by offering:
12 
13- **Syntax highlighting** for Markdown, MDX, YAML, and TypeScript
14- **An integrated terminal** for running CamelMind commands without leaving the editor
15- **File Explorer** for browsing your documentation files
16- **Project-wide search** for finding and updating content
17- **Thousands of extensions** for customizing your editing experience
18 
19If 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.
20 
21---
22 
23## Installing VS Code on your operating system
24 
25Select your operating system below to install Visual Studio Code:
26 
27<Tabs>
28<Tab label="macOS">
29 
30Download VS Code directly from [code.visualstudio.com](https://code.visualstudio.com/), or install it using Homebrew:
31 
32```bash
33brew install --cask visual-studio-code
34```
35 
36</Tab>
37 
38<Tab label="Windows">
39 
40Download VS Code from [code.visualstudio.com](https://code.visualstudio.com/) and run the setup wizard using default settings.
41 
42</Tab>
43 
44<Tab label="Linux">
45 
46Download the appropriate package from [code.visualstudio.com](https://code.visualstudio.com/), or install it using your distribution's package manager.
47 
48</Tab>
49</Tabs>
50 
51---
52 
53## Recommended extensions for CamelMind
54 
55After installing VS Code, open the **Extensions** view (`Cmd+Shift+X` on macOS or `Ctrl+Shift+X` on Windows/Linux) and install these recommended extensions:
56 
57| Extension | Why |
58| --- | --- |
59| **MDX** | Provides syntax highlighting and formatting for `.mdx` files. |
60| **YAML** | Provides validation and autocomplete for `nav/nav.yml`. |
61 
62<Callout type="tip">
63VS 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.
64</Callout>
65 
66---
67 
68## Learning Markdown and MDX basics
69 
70CamelMind authors write pages using **MDX**, which combines standard Markdown syntax with interactive components such as `<Callout>` and `<Steps>`.
71 
72If you have never written Markdown before, do not worry—you can learn it. Follow the [Writing Content](/getting-started/writing-content) guide after setting up your first site.
73 
74---
75 
76## Next step: Proceed to Node.js installation
77 
78Now that you have configured your text editor, continue to the [Install Node.js](/before-you-begin/install-nodejs) guide if you have not installed it already. Once complete, you can proceed directly to [create your first CamelMind site](/getting-started/installation).

Issues (1)

Notes (1)