中文版本 日本語版

Welcome to Zditor, an AI-powered markdown editor.

This repository is not the source code repository; it only contains documentation related to Zditor.

• Getting Started
• Roadmap
• MCP Server Configuration Guide

💬 Join wechat group

Zditor is a WYSIWYG markdown editor that supports basic markdown syntax and extends upon it. It currently supports Windows, Macos, and Linux platforms. To download, please visit the release download page.

Simple Demo of Zditor

• Macos currently does not have a signature. After downloading, two additional steps are required: during installation and the first time opening the app, go to Privacy & Security in Settings and select "Open Anyway."

Uses OpenAI SDK's streaming output, supporting both API and local models. As shown in the image below, you can fill in the relevant parameters. For the model section, separate the entries with commas (English commas). The ollama API key can be left blank.

Supports text selection and a separate chat tab. Text selection is for single-round conversations, while the chat tab supports multi-round conversations, file uploads, selecting documents as context, drag-and-drop uploads, etc.

A free license is provided. Simply enter your email, click "Send," and then retrieve the license from your email.

!!! warning License Not Recieved? Please allow 1-2 minutes for the email to arrive after you've been prompted to check your inbox. First, check your spam/junk folder. If it's still not there, you can wait two minutes and then resend.

For AI feature usage, refer to the AI Usage Guide. For Ollama configuration, refer to the Ollama Configuration Guide. For Agent usage, refer to the Agent Usage Guide. If a connection failure is prompted, please check first:

1. Is Ollama already running?

2. Is VPN enabled (may need to be disabled)?

3. Is CORS configured: https://objectgraph.com/blog/ollama-cors/

   

To test in the terminal, if curl -X OPTIONS http://localhost:11434 -H "Origin: http://example.com" -H "Access-Control-Request-Method: GET" -I displays "Forbidden", it means CORS is not enabled. For Windows systems, you need to configure the system environment variable: OLLAMA_ORIGINS. The specific steps are:

1. Open System Settings, search for "System Variables".
2. Click the pop-up dialog, select "Environment Variables".
3. Click "New", enter OLLAMA_ORIGINS and *.
4. Save, and restart Ollama.
5. Test: curl -X OPTIONS http://localhost:11434 -H "Origin: http://example.com" -H "Access-Control-Request-Method: GET" -I. If various headers are displayed, it means the setting was successful.
6. Open Zditor to test.

zditor supports many syntax formats, such as tables, formulas, Code Block, Smart Text, MetaData, etc.

For MCP server configuration, refer to the MCP Server Configuration Guide.