Last updated
Writing a README File
Use the editor's split-pane view to write a project README with live preview. Left pane (Markdown source):
# My Awesome Project
A brief description of what this project does.
## Installation
```bash
npm install my-awesome-project
```
## Usage
```javascript
const myProject = require('my-awesome-project');
myProject.doSomething({ option: 'value' });
```
## Features
- Feature one with description
- Feature two with description
- Feature three with description
## Contributing
Pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
[MIT](LICENSE)
Right pane shows the rendered HTML preview updating in real time as you type.
Using the Toolbar Buttons
The toolbar provides one-click insertion of common Markdown syntax:
- Bold button: Wraps selected text in
**...** - Italic button: Wraps selected text in
*...* - Heading button: Adds
##at the start of the line - Link button: Opens a dialog to enter URL and link text, inserts
[text](url) - Image button: Inserts
 - Code block button: Wraps selection in triple backticks
- Ordered list button: Adds
1.prefix - Unordered list button: Adds
-prefix - Table button: Inserts a template table structure
- Horizontal rule button: Inserts
---
Writing Technical Documentation
The editor handles complex technical content with code blocks and tables:
## API Reference
### GET /users/{id}
Returns a user object by ID.
**Parameters:**
| Parameter | Type | Required | Description |
|-----------|--------|----------|--------------------|
| id | string | Yes | The user's ID |
| fields | string | No | Comma-separated fields to return |
**Response:**
```json
{
"id": "user_123",
"name": "Alice Johnson",
"email": "alice@example.com",
"createdAt": "2024-01-15T10:30:00Z"
}
```
**Status codes:**
- `200` — Success
- `404` — User not found
- `401` — Unauthorized
Document Statistics
The editor shows real-time statistics as you write:
Document Statistics:
─────────────────────────────────────────────────────────────────────
Words: 847
Characters: 4,823
Characters (no spaces): 4,012
Paragraphs: 12
Headings: 5 (1 H1, 3 H2, 1 H3)
Links: 8
Images: 2
Code blocks: 4
Reading time: ~4 minutes (at 200 words/minute)
Keyboard Shortcuts
Common keyboard shortcuts for efficient editing:
Formatting:
Ctrl+B Bold
Ctrl+I Italic
Ctrl+K Insert link
Ctrl+` Inline code
Ctrl+Shift+K Code block
Navigation:
Ctrl+Home Go to beginning
Ctrl+End Go to end
Ctrl+F Find
Ctrl+H Find and replace
Document:
Ctrl+S Save/download
Ctrl+Z Undo
Ctrl+Y Redo
Ctrl+A Select all
Exporting Your Document
Export options available from the editor:
Export as Markdown (.md):
Downloads the raw Markdown source file.
Use for: GitHub repositories, documentation systems,
version control.
Export as HTML:
Downloads a complete HTML file with the rendered content.
Includes: proper DOCTYPE, meta tags, and semantic HTML.
Use for: web pages, email content, CMS import.
Copy HTML to clipboard:
Copies just the rendered HTML body content (no DOCTYPE/head).
Use for: pasting into CMS editors, email builders,
or web page templates.
Copy Markdown to clipboard:
Copies the raw Markdown source.
Use for: pasting into GitHub, GitLab, Notion, or other
Markdown-supporting platforms.
Writing a Blog Post
The editor is well-suited for writing long-form content:
---
title: Getting Started with Docker
date: 2024-01-15
tags: [docker, devops, containers]
---
# Getting Started with Docker
Docker simplifies application deployment by packaging your
application and its dependencies into a container.
## What is a Container?
A container is a lightweight, standalone executable package
that includes everything needed to run an application:
code, runtime, system tools, libraries, and settings.
> **Note:** Containers are not virtual machines. They share
> the host OS kernel, making them much more lightweight.
## Installing Docker
1. Visit [docker.com](https://docker.com)
2. Download Docker Desktop for your OS
3. Follow the installation wizard
4. Verify installation:
```bash
docker --version
docker run hello-world
```
Scroll Synchronization
When editing a long document, the preview pane stays synchronized with your editing position:
Behavior:
- As you scroll the source pane, the preview scrolls to match
- When you click in the source, the preview jumps to that section
- The active heading in the preview is highlighted
This means you always see the rendered version of the section
you are currently editing, without manually scrolling the preview.
Useful for: Long documentation files, book chapters,
comprehensive README files with many sections.