📦 littlecodersh / LocalNote

📄 README.md · 62 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62# LocalNote [![Gitter](https://badges.gitter.im/littlecodersh/LocalNote.svg)](https://gitter.im/littlecodersh/LocalNote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ![python](https://img.shields.io/badge/python-2.7-ff69b4.svg)

LocalNote让你能够像使用本地文件一样使用印象笔记。

支持流行的markdown格式的笔记,印象笔记中完美显示,上传重新下载笔记仍可编辑。

三平台支持,在linux平台也流畅的使用印象笔记。

# Screenshot

![](http://7xrip4.com1.z0.glb.clouddn.com/LocalNoteDemo.gif)

视频见[这里](http://v.youku.com/v_show/id_XMTU3Nzc5NzU1Ng==)

# Installation

```bash
pip install localnote
```

# Usage

## 常用命令

```bash
# 初始化印象笔记目录,请在空文件夹使用
localnote init
# 下载笔记
localnote pull
# 查看云端及本地笔记更改
localnote status
# 上传本地笔记
localnote push
```

## 存储格式
* 根目录下每个文件夹对应一个笔记本
* 笔记本文件夹中每个文件(文件夹)对应一个笔记
* 笔记可以仅存在主文件也可以以文件夹的形式包含附件
* 笔记主文件必须是`.md`或者`.html`格式,文件名(不包括后缀)将会被用作笔记名

## 示例文件树

```
Root
    我的默认笔记本
        第一个笔记.html
        第二个笔记.html
    附件笔记本
        第三个笔记
            第三个笔记.md
            打包材料.zip
            打包笔记.txt
    空笔记本
```

# Comments

如果有什么问题或者建议都可以在这个[Issue](https://github.com/littlecodersh/LocalNote/issues/1)和我讨论。

或者也可以在gitter上交流: [![Gitter](https://badges.gitter.im/littlecodersh/LocalNote.svg)](https://gitter.im/littlecodersh/LocalNote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)