WriteOnSide

KO | EN

gitlite — search

#php #markdown #containers #sql #framework #agents #react #anthropic #nextjs #electron

(★ 9)

WriteOnSide, a "Sidenote" app for Windows.

File Explorer

ZIP Download

- - image1.png
  - writeonside-screenshot.png
  - writeonside-screenshot1.png
- icon_dark.png
- icon_light.png
- WriteOnSide.ico
- writeonside_logo_dark.svg
- writeonside_logo_light.svg
- Embed_Render_Sample.md
- MICROSOFT_STORE.md
- PLUGIN_GUIDE.md
- STORE_LISTING.md
- GPL-3.0.txt
- keyboard-MIT.txt
- pdfium-BSD-Apache.txt
- pillow-MIT-CMU.txt
- pygments-BSD-2-Clause.txt
- pypdfium2-BSD-3-Clause.txt
- pystray-LGPL-3.0.txt
- python-PSF.txt
- six-MIT.txt
- svg2png-py-MIT.txt
- tcl-tk-license.txt
- tkdnd-license.txt
- tkinterdnd2-MIT.txt
- watchdog-Apache-2.0.txt
- - main.js
  - manifest.json
  - README.md
- - Cargo.lock
  - Cargo.toml
  - pyproject.toml
- - Cargo.lock
  - Cargo.toml
  - pyproject.toml
- - hook-PIL.Image.py
  - hook-pygments.py
- export_icons.py
- prepare_readmes.py
- test_app_lifecycle.py
- test_attachment_organizer.py
- test_attachment_paths.py
- test_color_picker.py
- test_color_tags.py
- test_config.py
- test_custom_themes.py
- test_diagnostics.py
- test_dialogs.py
- test_document_performance.py
- test_drag_preview_overlay.py
- test_drag_preview_preheat.py
- test_editor_caret.py
- test_editor_drop_caret.py
- test_editor_image_preview_chunking.py
- test_editor_images.py
- test_editor_scroll_render_loop.py
- test_editor_structure.py
- test_embed_caret.py
- test_embed_text_host_chunking.py
- test_explorer_clipboard.py
- test_explorer_toggle_perf.py
- test_file_drag_icons.py
- test_file_labels.py
- test_find_replace.py
- test_focus_switch_perf.py
- test_format_icons.py
- test_frontmatter_and_index.py
- test_high_priority_optimizations.py
- test_hotkeys.py
- test_i18n.py
- test_image_file_drag.py
- test_image_viewer.py
- test_large_source_highlight.py
- test_layout_metrics.py
- test_licenses_info.py
- test_linked_file_opening.py
- test_live_preview_render_reuse.py
- test_markdown_tables_and_attachments.py
- test_notes_service_and_index.py
- test_obsidian_features.py
- test_pdf_preview.py
- test_pedigree_plugin.py
- test_platform_startup.py
- test_plugin_typography.py
- test_plugins.py
- test_quick_search.py
- test_settings_typography.py
- test_shortcuts_and_images.py
- test_smooth_layout_drag.py
- test_startup_repair.py
- test_sticky_notes_plugin.py
- test_storage_backup_async.py
- test_syntax_highlight.py
- test_tag_filter_cascade.py
- test_text_external_drag.py
- test_text_files.py
- test_theme_utils.py
- test_typography.py
- test_vault_watcher.py
- test_webdav_sync_deletions.py
- test_welcome.py
- test_wikilink_rename.py
- test_wikilinks_and_storage.py
- test_wikilinks_asset_index_perf.py
- test_window_animation.py
- test_word_count.py
- - __init__.py
  - attachment_organizer.py
  - color_picker.py
  - pedigree_analysis.py
  - quick_search.py
  - sticky_notes.py
  - theme_editor.py
  - webdav_sync.py
- - __init__.py
  - de.py
  - en.py
  - fr.py
  - hi.py
  - it.py
  - ko.py
  - nl.py
  - pt.py
  - uk.py
  - zh.py
- - __init__.py
  - service.py
- - __init__.py
  - about.py
  - attachment_index_ui.py
  - command_shortcuts.py
  - dialogs.py
  - editor.py
  - editor_structure.py
  - embed_text_host.py
  - explorer.py
  - i18n_ui.py
  - image_viewer.py
  - live_markdown_host.py
  - notes.py
  - plugin_ui.py
  - plugins.py
  - settings.py
  - theme_utils.py
  - tray_manager.py
  - typography.py
  - vault_watcher.py
  - wikilinks_ui.py
  - window.py
- __init__.py
- app.py
- attachment_index.py
- color_picker_store.py
- config.py
- diagnostics.py
- document_performance.py
- drag_preview_overlay.py
- dragdrop.py
- editor_images.py
- embed_caret.py
- file_icons.py
- file_labels.py
- format_icons.py
- frontmatter.py
- hotkeys.py
- i18n.py
- image_safety.py
- layout_metrics.py
- licenses_info.py
- live_highlight.py
- markdown.py
- note_index.py
- obsidian_md.py
- platform.py
- plugins.py
- preview.py
- shortcuts.py
- storage.py
- syntax_highlight.py
- text_files.py
- theme.py
- typography.py
- welcome.py
- wikilinks.py
- word_count.py
.gitignore
build_release.ps1
BUILDING.md
LICENSE
PRIVACY.md
README.md
requirements.txt
THIRD_PARTY_NOTICES.md
VERSION
version_info.txt
writeonside.py
WriteOnSide.spec

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">WriteOnSide</h1>

Your notes, one shortcut away. 
 A local-first Markdown and text editor that lives at the edge of Windows.

<a href="https://github.com/Thymine2001/WriteOnSide/releases">Download for Windows</a>
 ·
 <a href="#quick-start">Quick start</a>
 ·
 <a href="#run-from-source">Run from source</a>

WriteOnSide（**随边记**）is a lightweight side-panel editor for quick capture,
Markdown writing, local knowledge bases, and small source-file edits. Press one
global shortcut and it slides in beside whatever you are doing. Press it again
and it gets out of the way.

There is no proprietary database and no required account. Notes remain ordinary
files in a folder you choose, ready to use with VS Code, Git, backup software,
or any other tool you trust.

> [!NOTE]
> WriteOnSide is under active development. Back up important notes and review
> release notes before upgrading.

## Why WriteOnSide?

- **Instant access.** Show or hide the panel globally with `Ctrl+Shift+Enter`.
- **Local by default.** Your notes and attachments stay in your chosen folder.
- **A real Markdown workspace.** Edit, render, search, link, tag, and organize notes without opening a full-screen application.
- **Rich linking.** Wiki links, embeds, backlinks, YAML metadata, tags, and portable attachments.
- **Useful beyond notes.** Edit common text, configuration, web, and source-code files with syntax highlighting.
- **Fits your desktop.** Choose either screen edge and configure width, opacity, typography, theme, behavior, and shortcuts.

## Quick start

<table>
 <tr>
 <td width="92" align="center">
 <picture>
 <source media="(prefers-color-scheme: dark)" srcset="assets/icon_dark.png" />
 <source media="(prefers-color-scheme: light)" srcset="assets/icon_light.png" />
 <img src="assets/icon_light.png" alt="WriteOnSide application icon" width="72" />
 </picture>
 </td>
 <td>
 No installer required. 
 Download the portable executable, choose your notes folder, and start writing.
 </td>
 </tr>
</table>

1. Download the newest `WriteOnSide.exe` from [GitHub Releases](https://github.com/Thymine2001/WriteOnSide/releases).
2. Run it and select a notes folder.
3. Follow the generated `Welcome.md` guide to create your first note and explore the workspace.
4. Use `Ctrl+Shift+Enter` whenever you want to show or hide the panel.

WriteOnSide is a portable, single-file Windows application. Windows SmartScreen
may warn about unsigned development builds; verify that the executable came from
this repository before running it.

## Highlights

### ✍️ Write and read

- Live Markdown highlighting in Edit mode and a clean rendered Read mode
- Formatting commands for headings, emphasis, color, highlights, quotes, lists, tasks, tables, links, images, and code
- Rendered images, clickable links, callouts, note embeds, footnotes, and copyable fenced code blocks
- YAML front matter editor for titles, tags, dates, aliases, and other metadata
- Line numbers, heading folding, sticky headings, and outline navigation
- Find and replace, configurable auto-save, and command shortcuts
- Large-document safeguards that keep editing responsive

### 🔗 Connect and organize

- Wiki links with completion: `[[Note]]`, `[[Note|alias]]`, `[[Note#Heading]]`, and `[[Note#^block-id]]`
- `Ctrl`+click navigation and create-on-follow for missing wiki-link targets
- Backlinks for every note that points to the current note
- Note and image embeds with `![[...]]`
- Inline and nested tags such as `#idea` and `#project/writeonside`
- Multi-select YAML tag filtering from the Files panel
- Eight preset file-label colors plus one user-defined color, with text-only, color-only, or combined tag views
- Portable `writeonside_colors` and `writeonside_pinned` YAML properties for Markdown notes
- Optional creation-date filtering, enabled from the Tags adjustment menu
- Incoming wiki-link updates when a note is renamed

### 📁 Work across files

- Recursive workspace search by filename and content
- Create, rename, move, copy, paste, delete, preview, reveal, and open files externally
- Drag files and folders within the workspace to move them; drag external items in to copy them
- Pin important notes to the top of Files with a visible `📌` marker
- Paste or drag images directly into Markdown notes
- Configurable attachment folder with portable relative links
- Image preview with zoom and pan
- Split editing with up to four open notes

### 🪟 Stay out of the way

- Borderless, always-on-top panel on the left or right screen edge
- Resizable editor and Files panel with adjustable opacity
- Global show/hide shortcut and Windows system-tray controls
- Optional launch at Windows startup
- Single-instance behavior and multi-monitor work-area positioning
- Light and dark themes with configurable fonts and sizes

## Markdown features

| Feature | Support |
|---|:---:|
| Standard Markdown headings, emphasis, lists, quotes, links, images, tables, and code | Yes |
| Wiki links, aliases, heading links, and block references | Yes |
| Note and image embeds | Yes |
| Backlinks and rename-aware incoming links | Yes |
| YAML front matter, aliases, and tag filtering | Yes |
| Inline and nested tags | Yes |
| Task lists, footnotes, comments, and dividers | Yes |
| Callouts | Read mode |
| Inline HTML colors, underline, superscript, and subscript | Yes |

WriteOnSide reads and writes normal Markdown as a fully standalone
application; no other note-taking software is required.

## Supported files

Markdown, plain-text, log, CSV, web, configuration, data, script, and common
source-code formats can be edited directly. This includes Python, JavaScript,
TypeScript, HTML, CSS, JSON, YAML, TOML, PowerShell, shell scripts, C/C++, C#,
Java, Kotlin, Rust, Go.
Images in PNG, APNG, JPEG/JFIF, GIF, BMP/DIB, WebP, TIFF, ICO/CUR,
JPEG 2000, SVG/SVGZ, ICNS, DDS, PSD, TGA, PCX, PPM/PGM/PBM,
QOI, XBM, XPM, and other Pillow-decodable formats can be inserted or previewed.
Other files can be opened with their default Windows application.

## Privacy and data safety

- WriteOnSide has no account system, built-in cloud, or hidden note database.
- No telemetry, no analytics, no update pings — see the full [Privacy Policy](PRIVACY.md).
- Notes leave your computer only when **you** place their folder in a separately configured sync service.
- Files are saved atomically to reduce the risk of partial writes.
- Replaced files receive timestamped managed backups outside the workspace.

Managed backups are a recovery aid, not a complete backup strategy. Use a
versioned or synced backup for important work.

## Essential shortcuts

| Action | Default shortcut |
|---|---:|
| Show or hide WriteOnSide | `Ctrl+Shift+Enter` |
| New note | `Ctrl+N` |
| Open file | `Ctrl+O` |
| Save | `Ctrl+S` |
| Toggle Edit / Read mode | `Ctrl+E` |
| Find / Replace | `Ctrl+F` / `Ctrl+H` |
| Outline | `Ctrl+Shift+O` |
| Backlinks | `Ctrl+Shift+B` |

Editor command shortcuts and the global shortcut can be reassigned in Settings.

## Interface languages

English · 中文 · Português · Deutsch · Français · Nederlands · 한국어 · Italiano · हिन्दी · Українська

Change the interface language under **Settings → General → Language**.

## Run from source

### Requirements

- Windows 10 or Windows 11
- Python 3.12

```powershell
git clone https://github.com/Thymine2001/WriteOnSide.git
cd WriteOnSide

py -3.12 -m venv .venv
.\.venv\Scripts\python.exe -m pip install --upgrade pip
.\.venv\Scripts\python.exe -m pip install -r requirements.txt
.\.venv\Scripts\python.exe .\writeonside.py
```

## Development

Run the test suite:

```powershell
.\.venv\Scripts\python.exe -m unittest discover -s tests -p "test_*.py"
```

Build a portable Windows executable:

```powershell
.\.venv\Scripts\python.exe -m pip install pyinstaller
.\build_release.ps1
```

The release script updates version metadata, exports application icons, builds
the single-file executable, and writes it to a versioned distribution folder.
See [BUILDING.md](BUILDING.md) for the complete packaging workflow.

## Data locations

| Data | Location |
|---|---|
| Notes and attachments | User-selected folder |
| Settings | `%LOCALAPPDATA%\WriteOnSide\config.json` |
| Managed backups | `%LOCALAPPDATA%\WriteOnSide\Backups\` |

## License

WriteOnSide is released under the [MIT License](LICENSE). Third-party components
retain their respective licenses; see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

Local files. Fast capture. No lock-in.

WriteOnSide

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README