# acdown

**Repository Path**: anschaser/acdown

## Basic Information

- **Project Name**: acdown
- **Description**: personal documents
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-05
- **Last Updated**: 2023-12-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 安装
克隆项目到本地后进入项目文件夹

```sh
pnpm install
pnpm link --global
pnpm dev  # 启动开发环境
pnpm build # 打包
```


# 独立的文档仓库

## 目录结构
在其它位置创建一个仓库来管理你的文档，参考如下目录结构：  
```
.
|-- pubdocs
  |-- 分类1
    |-- 文章1.md
    |-- 文章2.md
  |-- 分类2
    |-- 文章1.md
    |-- 文章2.md
```

## 创建文章索引
进入该仓库文件夹，执行如下命令来创建文件索引：
```sh
acdown <mki/mkindex>
```
它会在仓库的根目录新建一个名为 `acdown-index.json` 的索引文件  
文章更新后，如果需要更新app数据，请再次执行此命令更像索引

## 记录文章信息
在md文章的顶部添加注释可以设置需要展示的信息：  
#### 1. 文章日期  
  ```markdown
  <!-- yyyy.mm.dd -->
  ```
#### 2. 文章简介  
  ```markdown
  <!-- 输入不符合上述任何格式的文本作为本文简介 -->
  ```