写作指南

写作指南

在数字花园中创建和管理笔记的实用方法。

创建笔记

content/ 目录创建 .md 文件:

content/
├── 我的想法.md
├── 学习笔记/
│   ├── JavaScript.md
│   └── Python.md
└── 项目/
    └── 网站重构.md

基本语法

页面配置

每个文件开头可以添加配置:

MARKDOWN
---
title: 页面标题
description: 页面描述
tags: [学习, 笔记]
category: 技术
created: 2024-07-01
updated: 2024-07-02
---

Markdown 语法

文本格式:

MARKDOWN
**粗体** *斜体* ~~删除线~~ `代码`

列表:

MARKDOWN
- 无序列表
- 另一项

1. 有序列表
2. 第二项

链接:

MARKDOWN
[外部链接](https://example.com)
[[内部双链]]

代码块:

MARKDOWN
```javascript
function hello() {
    console.log("Hello World!");
}
```

图片使用

支持 Obsidian 兼容的图片语法:

MARKDOWN
![[图片.jpg]]          # 基本图片
![[图片.jpg|300]]       # 设置宽度
![[图片.jpg|400x300]]   # 设置宽高

双链笔记

用双方括号创建笔记间的链接:

MARKDOWN
[[笔记名]]              # 基本链接
[[笔记名|显示文字]]      # 自定义显示
[[笔记名#标题]]         # 链接到标题

特性:

  • 大小写不敏感:[[GitHub]][[github]] 相同
  • 自动搜索:系统会在整个content目录查找
  • 反向链接:自动显示哪些笔记链接到当前页面

卡片视图

将列表转换为卡片展示:

MARKDOWN
---
title: 我的项目
cssclasses: list-cards
---

- ![[项目截图.png]]
  - **项目名称**
  - 项目描述
  - 链接:[[项目详解]]

写作建议

  1. 清晰的文件名:使用有意义的中文名
  2. 适当的标签:帮助分类和搜索
  3. 建立连接:多使用双链连接相关内容
  4. 定期整理:回顾和更新内容

详细的双链功能请查看 双链笔记