Try โ€‚โ€‰HackMD

Understanding Your Editor

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Working in Progress
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

CodiMD Logo Brand Logo, click the logo can goto homepage.

2. Editor Mode Switcher

You can change workspace layout by click the button. there has three type of layout.

  • Edit: See only the editor.
  • View: See only the result.
  • Both: See both in split view.

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

3. Night Theme Switcher

You can click this button to change the whole workspace theme to Night Theme or Normal Theme.

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

4. Help Button

Clicking Help Button to view quick tips about Markdown Syntax.

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

5. Upload Image Button

Clicking this button to select an image to upload into CodiMD. The image backend service is depends on your server configuration CMD_IMAGE_UPLOAD_TYPE. The default settings is upload to imgur via anonymous.

6. Last Change Time and Username

This area display the documentation last changed time and last changed user.

7. New Note Button

Clicking this button to create new CodiMD note on new browser tab.

8. Publish Button

Clicking this button to open a new tab in browser that showing the note in published mode.

9. Note Menu

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

10. Online Indicator

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

11. Permission and Note Deletion button

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

12. Preview Area

13. Table of Content

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

14. Documentation Length

Show the note total length in character count.

The maximum length of documentation is 100,000. Although you can change this limit via documentMaxLength config, But we don't recommend this way.

15. Editor Preference

16. Editor Shortcut Profile

CodiMD supports three type keyboard shortcut profile.

  • Sublime
  • Emacs
  • Vim

You can click this button to change profile.

17. Space/Tab Indent Switch

You can clicking this button to switch between space and tab mode in you type TAB key in editor.

18. Editor Color Theme

This feature needs CodiMD 2.0.0.

CodiMD supports change editor theme.
You can click this button to change editor theme. The theme we support is showing below:

  • Light
  • One Dark (Default)
  • Monokai
  • Solarized Dark
  • Solarized Light
  • Dracula
  • Material
  • Nord
  • Panda
  • Ayu Dark
  • Ayu Mirage
  • Tomorror Night Bright
  • Tomorror Night Eighties

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

19. Spell Check

CodiMD multi-language spell check is support after 2.0.0.

Image Not Showing Possible Reasons
  • The image was uploaded to a note which you don't have access to
  • The note which the image was originally uploaded to has been deleted
Learn More โ†’

Clicking on

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
button to enable spell check. Currently we support four languages:

  • English (United States)
  • German
  • German (Austria)
  • German (Switzerland)

20. Markdown Lint

Clicking on the

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’
button to enable Markdown Lint. You can check this page for more markdown rules

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More โ†’

21. Editor Cursor Indicator

This area shows cursor information about current cursor. It's contains

  • current line number
  • current cursor column
  • total line numbers

22. Editor Area

23. Editor Toolbar