程序员需要写大量文档?MarkText支持丰富的代码高亮主题、多种编程语言的代码块、Mermaid图表,是编写技术文档、README文件和代码笔记的绝佳工具。
MarkText支持的主流编程语言:
开源项目README用MarkText编写:
# 项目名称
简洁的项目描述
## 功能特性
- ✅ 特性一
- ✅ 特性二
## 快速开始
\`\`\`bash
npm install my-project
npm run dev
\`\`\`
## 代码示例
\`\`\`javascript
const result = myFunction();
console.log(result);
\`\`\`
## API文档
### myFunction()
参数说明...
返回值说明...
使用MarkText编写接口文档:
## 用户接口
### 获取用户信息
**请求**
\`\`\`
GET /api/users/:id
\`\`\`
**参数**
| 参数 | 类型 | 说明 |
|------|------|------|
| id | number | 用户ID |
**响应**
\`\`\`json
{
"id": 1,
"name": "张三",
"email": "zhangsan@example.com"
}
\`\`\`
**示例**
\`\`\`javascript
const user = await fetch('/api/users/1');
\`\`\``
程序员日常学习笔记:
## Python装饰器学习笔记
### 基础装饰器
\`\`\`python
def my_decorator(func):
def wrapper():
print("执行前")
func()
print("执行后")
return wrapper
@my_decorator
def say_hello():
print("Hello!")
\`\`\`
### 装饰器工厂
\`\`\`python
def logging(level):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print(f"[{level}] 调用函数")
return func(*args, **kwargs)
return wrapper
return decorator
\`\`\``
MarkText支持Mermaid图表:
```mermaid
graph TD
A[开始] --> B{判断条件}
B -->|条件A| C[处理A]
B -->|条件B| D[处理B]
C --> E[结束]
D --> E
开启优雅写作之旅
sudo snap install marktext (Linux)