# zettelkasten

**Repository Path**: sevenclear/zettelkasten

## Basic Information

- **Project Name**: zettelkasten
- **Description**: 基于zettelkasten 翻译markdown，供workstation使用，实现网页和本地文件分开托管
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-26
- **Last Updated**: 2025-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Markdown

## README

# Zettelkasten

## 介绍
基于 Zettelkasten 方法的 Markdown 文档处理工具，支持网页和本地文件分开托管。本工具可以将本地 Markdown 文档转换为支持双向链接的博客文档。

## 功能特点
- 支持 Markdown 文件处理和转换
- 自动生成文档间的双向链接
- 支持文档分类和标签管理
- 自动处理图片资源（支持 PNG 和 SVG）
  - PNG 图片自动转换为 Base64 编码
  - SVG 文件直接嵌入文档
- 支持 Front Matter 元数据管理
- 基于雪花算法的文档 ID 生成

## 使用方法

### 文档格式要求
1. Markdown 文件需要以 `.md` 结尾
2. 支持 Front Matter 格式的元数据
```yaml
---
category=分类1,分类2
tag=标签1,标签2
---
```
3. 支持双向链接语法：`[[文档名]]`

### 目录结构
```
your-docs/
├── category1/        # 分类目录
│   ├── doc1.md
│   └── doc2.md
├── category2/
│   └── doc3.md
└── build/           # 生成的博客文件
```

### 编译命令
```kotlin
val genBlog = GenBlog("你的文档目录路径")
genBlog.generate()
genBlog.writeScanResult()
```

## 技术栈
- Kotlin
- Hutool
- Apache Commons
- Gson

## 开发环境要求
- JDK 8+
- Kotlin 环境

## 许可证
[待补充]

## 贡献指南
欢迎提交 Issue 和 Pull Request