Skip to content

DINKIssTyle/DINKIssTyle-Markdown-Browser

Repository files navigation

Introduction to DKST Markdown Browser

A lightweight and elegant cross-platform
Markdown viewer and editor!

NEWS

✨ New! Version 2.0!

  • AI Support: AI assistant feature to write and edit Markdown documents.
  • Flow State: A continuous writing Markdown editor that doesn't interrupt your workflow.


FEATURES

This document describes the features of DKST Markdown Browser.
DKST Markdown Browser allows you to read, edit, or create new Markdown documents.

Common

  • Open Markdown: Open Markdown files.
  • Sidebar - File Tree: Navigate the directory structure of open documents.
  • Sidebar - Search: Search for keywords in open documents and subfolders.
  • Image Viewer: Provides basic functions such as browsing and zooming in/out of opened images via the file tree.
  • Keyboard Accessibility: Most functions can be accessed or navigated using the keyboard.
  • Supported Extensions: .md, .markdown

Reader

DKST Markdown Browser excels at browsing hyperlinked Markdown documents and offers the following features:

  • Sidebar - Outline: Visually displays the structure of a Markdown document and organizes it like a table of contents, allowing quick jumps to specific locations.
  • Hyperlink Navigation: Browse hyperlinked Markdown documents as if they were in a web browser.
  • Home Function: The first opened document serves as the home, and you can easily return to it even when navigating to other documents via hyperlinks.
  • Font Size Adjustment: Easily adjust the document font size using buttons or keyboard shortcuts.
  • Light, Dark Themes: Choose between light and dark themes according to your preference.
  • Print Function: Print the document.
  • Rendering Engine: Select between Marked and Remark.
    • Rendered items:
      • Formulas: Renders LaTeX formulas to HTML using katex*.
      • Diagrams: Renders Mermaid code blocks to SVG using Mermaid.
      • Syntax Highlight: Renders code blocks using highlight.js.

Editor

DKST Markdown Browser provides a modern Markdown document editing environment by embedding CodeMirror.

  • Syntax Highlight: Supports Syntax Highlighting to improve readability during editing, allowing you to select presets or configure custom color palettes in settings.
  • / Shortcut: Pressing / while editing allows you to use toolbar tools without needing a mouse click.
  • Link Insertion: Easily insert URLs or local documents. Inserting a local document uses relative paths, making document creation convenient.
  • Image Insertion: Easily insert URLs or local images. Inserting a local image uses relative paths, making document creation convenient.
  • Insertion via Sidebar - File Tree: Select a document, file, or image from the file tree and use the right-click menu to insert that item directly at the cursor position in the editor.
  • Intelligent Path Judgment for Insertion: When inserting a document or image, if the path contains spaces, it is enclosed in < and > for universality.
  • Documents Linked During Editing: If you click a hyperlink in the document being edited, that document is displayed in the viewer. A floating button is provided to return to the document being edited or open it in a new tab.
  • Editor and Viewer Scroll Synchronization: Synchronizes the scroll position between the editing screen and the rendered viewer. This can be disabled in options.
  • Find and Replace: Search or batch replace text within the document being edited.
  • CJK Compatibility Mode: Available in a mode compatible with CodeMirror and the "Marked Text" input method of East Asian input methods, preventing unnecessary blank lines.
  • Editor Font Size Adjustment: Easily adjust the font size of the editing window using buttons or keyboard shortcuts.

[!TIP] Learn about Default Shortcuts. Using shortcuts is very convenient.

Editor with AI Assist

DKST Markdown Browser offers AI assist utilizing a Local LLM; please check the AI section in the editor settings to configure and toggle this feature.

  • AI Feature Toolbar: When activated, an AI floating button appears in the bottom left corner of the editor.
    • Click the AI button to pause the feature.
    • Click the expand button to show or hide the entire AI feature toolbar.
      • Temperature: Adjust the temperature to control the creativity of the AI response. Higher temperatures result in more creative AI responses.
      • Autocomplete: Toggle Fill-in-the-Middle (FIM). Selecting an appropriate LLM model is necessary for proper operation.
      • Context+: Uses some preceding and succeeding text as context to assist the user. This may require more context budget and processing time.
      • Github Compatible: If you are writing documents for GitHub, the AI attempts assistance compliant with the GitHub Flavored Markdown (GFM) specification.
      • Talk to me: The AI processes the user's response and reports on the processing content in brief every time.

Trying out AI Features

Getting AI Assist with Text Selection

  1. Select the sentence you are editing. The AI prompt window appears upon selecting a sentence.
  2. Press / to directly input the prompt into the prompt window.
  3. Try starting lightly like this: Improve sentence, Translate to English
  4. The selected sentence will have been improved or translated.

Prompt Examples: "Organize into a table", "Wrap in div and center align with width 128px", "Change to lowercase", "Rewrite the sentence in simpler terms", "Spell check", "Draw as a diagram"

Getting AI Assist without Text Selection

  1. Press / and select Ask AI (Enter) to bring up the AI prompt window.
  2. You can also call the AI prompt using a shortcut: CTRL+/ or ⌘+/
  3. Try starting lightly like this: Enter 10 fruits and vegetables in a table, Write briefly about the benefits of apples in Markdown format
  4. You will see fruits and vegetables organized into a table, or the benefits of apples in an LLM-like response.

Prompt Examples: "Draw a cat inside a code block", "Write a Python Hello World example"

[!Note] The LLM operating in DKST Markdown Browser does not save the context of the conversation. This is to remain faithful to its role as a tool, and it does not remember previous conversations. Furthermore, it cannot refer to any external information such as the internet, current time, or location.

  • Recommended LLM Models
    • Use an LLM model in the range of 3B~4B that has limited or switchable Reasoning.
    • The quality of AI assistance can vary greatly depending on the LLM model you use.

Download

Download the latest release executable by clicking here.

Installation

Windows

Move the executable file to your desired location and use it.

macOS

The standard method is to move the executable (app bundle) to the Applications folder or the ~/Applications directory.

Since this app does not have a trusted developer signature, you must remove the 'Quarantine' attribute. Removing the 'Quarantine' attribute set on the app makes it a trusted file.

The command below is for when the app is installed in the Applications folder.

xattr -cr "/Applications/DKST Markdown Browser.app"

After entering the command, press Enter to remove quarantine.

Linux (Ubuntu, CentOS, etc.)

Run the executable and follow the installation link at the bottom of the start page to complete the installation.

Sponsorship

Sponsor
Sponsorship helps me continue to improve this project. — And it gives me a perfectly valid excuse to work late into the night without causing trouble at home.


Advanced Users

Prerequisites

  • Go: Version 1.23 or higher
  • Wails: Version v2.11.0 or higher
  • Node.js: Version 18 or higher (including npm)
  • CGO Tools: Required for native compilation (e.g., GCC or Clang)

Building from Source

macOS

The macOS build script generates a universal binary (if selected) and handles the application bundle (.app).

chmod +x build-macOS.sh
./build-macOS.sh [arm64 | amd64 | universal]

Windows

The Windows build script generates an executable (.exe) including an icon.

build-Windows.bat [amd64 | arm64 | 386]

Linux

The Linux build script generates a binary specific to the architecture.

chmod +x build-Linux.sh
./build-Linux.sh [amd64 | arm64 | arm]

License

Made by DINKIssTyle. Copyright (c) 2026 DINKI'ssTyle. All rights reserved. Refer to THIRD-PARTY-NOTICES.md for open-source library licenses.

About

DKST Markdown AI, View, edit, navigate, and proofread Markdown with AI (Local LLM).

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

 
 
 

Contributors