# LocalNote

**Repository Path**: omniworks/LocalNote

## Basic Information

- **Project Name**: LocalNote
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-11-10
- **Last Updated**: 2024-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ShockNotes

![python](https://img.shields.io/badge/python-3.6-ff69b4.svg) 

> [forked from LocalNote](https://github.com/littlecodersh/LocalNote/blob/master/README_EN.md)
> 原作者：[littlecoder]((https://github.com/littlecodersh))

> 让你能够像使用本地文件一样使用印象笔记。
> 支持流行的markdown格式的笔记，印象笔记中完美显示，上传重新下载笔记仍为`.md`格式。
> 支持印象笔记原笔记格式转化为markdown格式，轻松开始使用。
> 三平台支持，在linux平台也流畅的使用印象笔记。


# Usage

## 常用命令

```bash
# 启动本地服务（接收evernote授权验证，将获取到的oauth_verifier填写在 shocknotes init 命令的 shell提示中）
shocknotes daemon &
# 初始化印象笔记目录，请在空文件夹使用
shocknotes init
# 下载笔记
shocknotes pull
# 查看云端及本地笔记更改
shocknotes status
# 上传本地笔记
shocknotes push
# 将html转化为md格式
shocknotes convert 需要转换的文件.html
```

## 使用模式

你可以选择对整个印象笔记使用ShockNotes，或者只有单一一个笔记本使用ShockNotes

```bash
# 设定使用ShockNotes的笔记本（全笔记本使用不设定即可）
shocknotes notebook
```

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

## 示例文件树

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