Install a Code Editor

Set up Visual Studio Code or your preferred code editor for working with Mordoc documentation.

2 min read

Install a Code Editor

To create and edit markdown files for your Mordoc documentation, you'll need a code editor. This guide covers Visual Studio Code, but you can use any code editor or IDE you prefer.

Visual Studio Code (Recommended)

Visual Studio Code (VS Code) is a free, open-source code editor with excellent markdown support.

Download VS Code

Visit code.visualstudio.com
Download the installer for your operating system:
- Windows: Download the Windows installer
- macOS: Download the macOS installer
- Linux: Download the appropriate package (.deb, .rpm, or .snap)

Install VS Code

Windows:

Bash

# Run the downloaded installer
# Follow the installation wizard
# Check "Add to PATH" during installation

macOS:

Bash

# Open the downloaded .dmg file
# Drag VS Code to Applications folder

Linux (Ubuntu/Debian):

Bash

sudo dpkg -i code_*.deb
sudo apt-get install -f

Verify Installation

Open a terminal and run:

Bash

code --version

You should see the version number displayed.

Recommended Extensions for Markdown

Once VS Code is installed, consider adding these helpful extensions:

Extension	Purpose
Markdown All in One	Keyboard shortcuts, table of contents, and preview
markdownlint	Linting and style checking for markdown
Prettier	Code formatting for consistent style

Installing Extensions

Open VS Code
Click the Extensions icon in the sidebar (or press Ctrl+Shift+X)
Search for the extension name
Click "Install"

Markdown Preview

VS Code has built-in markdown preview. Press Ctrl+Shift+V (or Cmd+Shift+V on macOS) to preview your markdown files.

Alternative Code Editors

Mordoc works with any text editor. Here are some popular alternatives:

Sublime Text: Lightweight and fast
Atom: Hackable text editor from GitHub
IntelliJ IDEA: Full-featured IDE with markdown support
Notepad++: Windows-only, lightweight option
Vim/Neovim: Terminal-based editors for power users

Choose the editor you're most comfortable with. All you need is the ability to create and edit .md (markdown) and .yaml files.

Next Steps

Now that you have a code editor installed, proceed to:

Install Node.js - Required for running Mordoc
Install Git - Recommended for version control