leanote/README.md

# Leanote

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/leanote/leanote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Build Status](https://travis-ci.org/leanote/leanote.svg)](https://travis-ci.org/leanote/leanote)

## 1. Introduction

Leanote, Not Just A Notepad!
![leanote.png](leanote.png "")

**Some Features**

* Knowledge: Manage your knowledge in Leanote. Leanote contains the tinymce editor and a markdown editor, just enjoy yourself writing.
* Share: Share your knowledge with your friends in Leanote. You can invite your friends to join your notepad in the cloud so you can share knowledge.
* Cooperation: Collaborate with friends to improve your skills.
* Blog: Publish your knowledge and make Leanote your blog.

**Other Features**

* Support Markdown
* Writting mode
* Export note to PDF
* Note batch operation
* Custom theme for blog

## 2. Why we created Leanote
To be honest, our inspiration comes from Evernote. We use Evernote to manage our knowledge everyday. But we find that:
* Evernote's editor can't meet our needs, it does not have document navigation, it does not render code properly (as a programmer, syntax highlighted code rendering is a basic need), it cannot resize images and so forth
* We like markdown, but Evernote does not support it.
* We want to share our knowledge, so all of us have our blogs (e.g. on Wordpress) and our Evernote accounts, but why can not those two be one!
* ......

## 3. How to install Leanote

Leanote contains: Leanote Web & Server (this repository), [Desktop app](https://github.com/leanote/desktop-app), [iOS](https://github.com/leanote/leanote-ios), [Android](https://github.com/leanote/leanote-android). And all the products are open source!

You can install Leanote on your server, and use Leanote App (Desktop, iOs, Android) to sync notes with your self-hosted server.

Welcome to sign up on https://leanote.com, Leanote team provide a stable and reliable service for you.

More information about how to install Leanote please see:

* [Leanote binary distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-binary-distribution-installation-tutorial)
* [Leanote develop distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-develop-distribution-installation-tutorial)

## 4. How to develop Leanote

Please see [How-to-develop-leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91leanote)

## 5. Docs
* [Leanote binary distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-binary-distribution-installation-tutorial)
* [Leanote develop distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-develop-distribution-installation-tutorial)

More docs please see [wiki](https://github.com/leanote/leanote/wiki).

## 6. Contributors
Thank you to all the [contributors](https://github.com/leanote/leanote/graphs/contributors) on
this project. Your help is much appreciated.

## 7.Join us
Please fork this repository and contribute back using [pull requests](https://github.com/leanote/leanote/pulls).

If you find some problems or has some good ideas, please submit [issues](https://github.com/leanote/leanote/issues).

You are always welcomed!

## 8. Donation
Support us, [donate us](http://leanote.org/#donate). And thanks [donators](http://leanote.leanote.com/post/leanote-donation-list).

## 9. Related projects

* [Leanote Desktop App](https://github.com/leanote/desktop-app), [Download](http://app.leanote.com)
* [Leanote iOS](https://github.com/leanote/leanote-ios), [Download From App Store](https://itunes.apple.com/en/app/leanote/id1022302858?mt=8)
* [Leanote Android](https://github.com/Dminter/leanote-android-client), development phase

And also, you are welcome to join us.

## 9. Support & Join us

* Email: leanote@leanote.com
* [Leanote BBS](http://bbs.leanote.com)
* [Leanote Google Group](https://groups.google.com/forum/#!forum/leanote)
* QQ Group: 256076853, 158716820

-----------------------------------------------------------------------

# Leanote

## 1. 介绍

Leanote, 不只是笔记!

**特性**

* 知识管理: 通过Leanote来管理知识, Leanote有易操作的界面, 包含两款编辑器富文本编辑器和Markdown编辑器. 在Leanote, 你可以尽情享受写作.
* 博客: Leanote也可以作为你的博客, 将知识公开成博客, 让Leanote把你的知识传播的更远!
* 分享: 你也可以通过分享知识给好友, 让好友拥有你的知识.
* 协作: 在分享的同时也可以与好友一起协作知识.

**一些其它特性**

* 支持Markdown编辑
* 写作模式
* 支持PDF导出
* 支持批量操作
* 博客自定义主题, 实现高度定制化

## 2. 为什么我们要创建Leanote?
说实话, 我们曾是evernote的忠实粉丝, 但是我们也发现evernote的不足:
* evernote的编辑器不能满足我们的需求, 不能贴代码(格式会乱掉, 作为程序员, 代码是我们的基本需求啊), 图片不能缩放.
* 我们是markdown的爱好者, 可是evernote竟然没有.
* 我们也想将知识公开, 所以我们有自己的博客, 如wordpress, 但为什么这两者不能合二为一呢?
* 还有...

## 3.安装Leanote

Leanote云笔记产品包括: Leanote Web & Server(即本仓库), 桌面客户端, ios, android. 4端全部开源! 你可以下载它安装在自己的服务器上, Leanote的客户端可以连接自建的服务.

欢迎在 https://leanote.com 上注册, Leanote团队为你提供稳定可靠的服务.

这里详细整理了Leanote二进版和Leanote开发版的安装教程, 请移步至:

* [Leanote二进制详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)
* [Leanote开发版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)

## 4. 如何对Leanote进行二次开发

请查看 [How-to-develop-Leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91leanote)

## 5 相关文档
* [Leanote二进制版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)
* [Leanote开发版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)
* [Leanote source Leanote源码导读](https://github.com/leanote/leanote/wiki/Leanote-source-leanote源码导读)
* [Leanote blog theme api(中文版)](https://github.com/leanote/leanote/wiki/leanote-blog-theme-api)
* [How to develop leanote 如何开发Leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-如何开发leanote)

更多文档请查看 [wiki](https://github.com/leanote/leanote/wiki).

## 6. 贡献者

谢谢 [贡献者](https://github.com/leanote/leanote/graphs/contributors) 的贡献, Leanote因有你们而更完美!

## 7. 加入我们

欢迎提交[pull requests](https://github.com/leanote/leanote/pulls) 到leanote.

有任何问题或建议, 欢迎提交[issue](https://github.com/leanote/leanote/issues).

Leanote还有很多问题, 如果你喜欢它, 欢迎加入我们一起完善Leanote.

## 8. 捐赠
支持我们, [捐赠Leanote](http://leanote.org/#donate). 感谢[捐赠者](http://leanote.leanote.com/post/leanote-donation-list), 谢谢你们的鼓励, Leanote会一直坚持!

## 9. 其它相关项目
* [Leanote Desktop App](https://github.com/leanote/desktop-app), [下载地址](http://app.leanote.com)
* [Leanote iOS](https://github.com/leanote/leanote-ios), [从App Store下载](https://itunes.apple.com/zn/app/leanote/id1022302858?mt=8)
* [Leanote Android](https://github.com/Dminter/leanote-android-client), 开发阶段

欢迎加入我们!

## 联系&加入我们
* Email: leanote@leanote.com
* [Leanote 社区](http://bbs.leanote.com)
* QQ群: 256076853, 158716820(已满)
* [Leanote Google Group](https://groups.google.com/forum/#!forum/leanote)
edit readme 2014-12-27 23:28:03 +08:00			`# Leanote`
update readme 2015-10-27 23:17:15 +08:00
add chat room 2015-08-27 10:25:05 +08:00			`[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/leanote/leanote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)`
add travis status 2015-09-11 18:40:08 +08:00			`[![Build Status](https://travis-ci.org/leanote/leanote.svg)](https://travis-ci.org/leanote/leanote)`
update readme 2015-10-27 23:17:15 +08:00
update readme.md 2014-05-09 18:06:58 +08:00			`## 1. Introduction`
Initial commit 2014-05-05 01:07:19 -07:00
update readme 2015-10-27 23:25:17 +08:00			`Leanote, Not Just A Notepad!`
updated README.md 2014-12-07 00:23:00 +08:00			`![leanote.png](leanote.png "")`
readme 2014-05-06 22:40:29 +08:00
update readme.md 2014-05-09 18:08:11 +08:00			`Some Features`

update readme 2015-10-27 23:25:17 +08:00			`* Knowledge: Manage your knowledge in Leanote. Leanote contains the tinymce editor and a markdown editor, just enjoy yourself writing.`
			`* Share: Share your knowledge with your friends in Leanote. You can invite your friends to join your notepad in the cloud so you can share knowledge.`
README: Grammar & markdown fixes 2014-05-09 14:27:03 +02:00			`* Cooperation: Collaborate with friends to improve your skills.`
update readme 2015-10-27 23:25:17 +08:00			`* Blog: Publish your knowledge and make Leanote your blog.`
readme 2014-05-06 22:40:29 +08:00
update readme 2015-10-27 23:42:19 +08:00			`Other Features`

			`* Support Markdown`
			`* Writting mode`
			`* Export note to PDF`
			`* Note batch operation`
			`* Custom theme for blog`

update readme 2015-10-27 23:25:17 +08:00			`## 2. Why we created Leanote`
README: Grammar & markdown fixes 2014-05-09 14:27:03 +02:00			`To be honest, our inspiration comes from Evernote. We use Evernote to manage our knowledge everyday. But we find that:`
			`* Evernote's editor can't meet our needs, it does not have document navigation, it does not render code properly (as a programmer, syntax highlighted code rendering is a basic need), it cannot resize images and so forth`
			`* We like markdown, but Evernote does not support it.`
			`* We want to share our knowledge, so all of us have our blogs (e.g. on Wordpress) and our Evernote accounts, but why can not those two be one!`
readme 2014-05-06 22:40:29 +08:00			`* ......`

update readme 2015-10-27 23:25:17 +08:00			`## 3. How to install Leanote`
release v0.1 2014-05-09 17:56:14 +08:00
update readme 2015-10-27 23:42:19 +08:00			`Leanote contains: Leanote Web & Server (this repository), [Desktop app](https://github.com/leanote/desktop-app), [iOS](https://github.com/leanote/leanote-ios), [Android](https://github.com/leanote/leanote-android). And all the products are open source!`

			`You can install Leanote on your server, and use Leanote App (Desktop, iOs, Android) to sync notes with your self-hosted server.`

			`Welcome to sign up on https://leanote.com, Leanote team provide a stable and reliable service for you.`

update readme 2015-10-27 23:25:17 +08:00			`More information about how to install Leanote please see:`
update readme 2015-10-27 23:42:19 +08:00
update readme 2015-10-27 23:25:17 +08:00			`* [Leanote binary distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-binary-distribution-installation-tutorial)`
			`* [Leanote develop distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-develop-distribution-installation-tutorial)`
update readme 2014-12-07 22:02:01 +08:00
update readme 2015-10-27 23:25:17 +08:00			`## 4. How to develop Leanote`
readme 2014-05-06 22:54:05 +08:00
update readme 2014-06-15 13:31:08 +08:00			`Please see [How-to-develop-leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91leanote)`
Update README.md 2014-05-09 21:18:56 +08:00
update readme 2015-05-10 15:07:51 +08:00			`## 5. Docs`
update readme 2015-10-27 23:25:17 +08:00			`* [Leanote binary distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-binary-distribution-installation-tutorial)`
			`* [Leanote develop distribution installation tutorial](https://github.com/leanote/leanote/wiki/leanote-develop-distribution-installation-tutorial)`
update readme 2015-05-10 15:07:51 +08:00
update readme 2015-05-10 15:10:56 +08:00			`More docs please see [wiki](https://github.com/leanote/leanote/wiki).`

update readme 2015-05-10 15:07:51 +08:00			`## 6. Contributors`
update readme 2014-06-12 11:31:37 +08:00			`Thank you to all the [contributors](https://github.com/leanote/leanote/graphs/contributors) on`
			`this project. Your help is much appreciated.`

update readme 2015-05-10 15:07:51 +08:00			`## 7.Join us`
update readme 2014-06-12 11:35:14 +08:00			`Please fork this repository and contribute back using [pull requests](https://github.com/leanote/leanote/pulls).`
update readme 2014-06-12 11:31:37 +08:00
update readme 2015-05-10 15:07:51 +08:00			`If you find some problems or has some good ideas, please submit [issues](https://github.com/leanote/leanote/issues).`

			`You are always welcomed!`

			`## 8. Donation`
update readme 2015-05-10 15:10:56 +08:00			`Support us, [donate us](http://leanote.org/#donate). And thanks [donators](http://leanote.leanote.com/post/leanote-donation-list).`
update readme 2015-05-10 15:07:51 +08:00
			`## 9. Related projects`
update readme 2015-10-27 23:42:19 +08:00
update readme 2015-05-10 15:07:51 +08:00			`* [Leanote Desktop App](https://github.com/leanote/desktop-app), [Download](http://app.leanote.com)`
update readme 2015-10-27 23:25:17 +08:00			`* [Leanote iOS](https://github.com/leanote/leanote-ios), [Download From App Store](https://itunes.apple.com/en/app/leanote/id1022302858?mt=8)`
update readme 2015-05-10 15:07:51 +08:00			`* [Leanote Android](https://github.com/Dminter/leanote-android-client), development phase`
update readme 2014-12-07 22:02:01 +08:00
update readme 2015-05-10 15:07:51 +08:00			`And also, you are welcome to join us.`
test for commit 2015-05-06 23:39:56 +08:00
update readme 2015-08-21 23:52:28 +08:00			`## 9. Support & Join us`

			`* Email: leanote@leanote.com`
			`* [Leanote BBS](http://bbs.leanote.com)`
			`* [Leanote Google Group](https://groups.google.com/forum/#!forum/leanote)`
update readme 2015-10-27 23:25:17 +08:00			`* QQ Group: 256076853, 158716820`
update readme 2014-06-12 11:31:37 +08:00
			`-----------------------------------------------------------------------`
update readme 2014-12-07 22:02:01 +08:00
update readme 2015-10-27 23:17:15 +08:00			`# Leanote`

			`## 1. 介绍`

			`Leanote, 不只是笔记!`

			`特性`

update readme 2015-10-27 23:42:19 +08:00			`* 知识管理: 通过Leanote来管理知识, Leanote有易操作的界面, 包含两款编辑器富文本编辑器和Markdown编辑器. 在Leanote, 你可以尽情享受写作.`
			`* 博客: Leanote也可以作为你的博客, 将知识公开成博客, 让Leanote把你的知识传播的更远!`
update readme 2015-10-27 23:17:15 +08:00			`* 分享: 你也可以通过分享知识给好友, 让好友拥有你的知识.`
			`* 协作: 在分享的同时也可以与好友一起协作知识.`
update readme 2015-10-27 23:42:19 +08:00
			`一些其它特性`

			`* 支持Markdown编辑`
			`* 写作模式`
			`* 支持PDF导出`
			`* 支持批量操作`
			`* 博客自定义主题, 实现高度定制化`
update readme 2015-10-27 23:17:15 +08:00
update readme 2015-10-27 23:25:17 +08:00			`## 2. 为什么我们要创建Leanote?`
update readme 2015-10-27 23:17:15 +08:00			`说实话, 我们曾是evernote的忠实粉丝, 但是我们也发现evernote的不足:`
			`* evernote的编辑器不能满足我们的需求, 不能贴代码(格式会乱掉, 作为程序员, 代码是我们的基本需求啊), 图片不能缩放.`
			`* 我们是markdown的爱好者, 可是evernote竟然没有.`
			`* 我们也想将知识公开, 所以我们有自己的博客, 如wordpress, 但为什么这两者不能合二为一呢?`
			`* 还有...`

update readme 2015-10-27 23:25:17 +08:00			`## 3.安装Leanote`
update readme 2015-10-27 23:42:19 +08:00
			`Leanote云笔记产品包括: Leanote Web & Server(即本仓库), 桌面客户端, ios, android. 4端全部开源! 你可以下载它安装在自己的服务器上, Leanote的客户端可以连接自建的服务.`

			`欢迎在 https://leanote.com 上注册, Leanote团队为你提供稳定可靠的服务.`
update readme 2015-10-27 23:17:15 +08:00
update readme 2015-10-27 23:25:17 +08:00			`这里详细整理了Leanote二进版和Leanote开发版的安装教程, 请移步至:`
update readme 2015-10-27 23:17:15 +08:00
update readme 2015-10-27 23:25:17 +08:00			`* [Leanote二进制详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)`
			`* [Leanote开发版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)`
update readme 2015-10-27 23:17:15 +08:00
update readme 2015-10-27 23:25:17 +08:00			`## 4. 如何对Leanote进行二次开发`
update readme 2015-10-27 23:17:15 +08:00
update readme 2015-10-27 23:25:17 +08:00			`请查看 [How-to-develop-Leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91leanote)`
update readme 2015-10-27 23:17:15 +08:00
			`## 5 相关文档`
update readme 2015-10-27 23:25:17 +08:00			`* [Leanote二进制版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)`
			`* [Leanote开发版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)`
			`* [Leanote source Leanote源码导读](https://github.com/leanote/leanote/wiki/Leanote-source-leanote源码导读)`
			`* [Leanote blog theme api(中文版)](https://github.com/leanote/leanote/wiki/leanote-blog-theme-api)`
			`* [How to develop leanote 如何开发Leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-如何开发leanote)`
update readme 2015-10-27 23:17:15 +08:00
			`更多文档请查看 [wiki](https://github.com/leanote/leanote/wiki).`

			`## 6. 贡献者`
update readme 2015-10-27 23:42:19 +08:00
			`谢谢 [贡献者](https://github.com/leanote/leanote/graphs/contributors) 的贡献, Leanote因有你们而更完美!`
update readme 2015-10-27 23:17:15 +08:00
			`## 7. 加入我们`

			`欢迎提交[pull requests](https://github.com/leanote/leanote/pulls) 到leanote.`

			`有任何问题或建议, 欢迎提交[issue](https://github.com/leanote/leanote/issues).`

update readme 2015-10-27 23:25:17 +08:00			`Leanote还有很多问题, 如果你喜欢它, 欢迎加入我们一起完善Leanote.`
update readme 2015-10-27 23:17:15 +08:00
			`## 8. 捐赠`
			`支持我们, [捐赠Leanote](http://leanote.org/#donate). 感谢[捐赠者](http://leanote.leanote.com/post/leanote-donation-list), 谢谢你们的鼓励, Leanote会一直坚持!`

			`## 9. 其它相关项目`
			`* [Leanote Desktop App](https://github.com/leanote/desktop-app), [下载地址](http://app.leanote.com)`
update readme 2015-10-27 23:25:17 +08:00			`* [Leanote iOS](https://github.com/leanote/leanote-ios), [从App Store下载](https://itunes.apple.com/zn/app/leanote/id1022302858?mt=8)`
update readme 2015-10-27 23:17:15 +08:00			`* [Leanote Android](https://github.com/Dminter/leanote-android-client), 开发阶段`

			`欢迎加入我们!`

			`## 联系&加入我们`
			`* Email: leanote@leanote.com`
update readme 2015-10-27 23:25:17 +08:00			`* [Leanote 社区](http://bbs.leanote.com)`
			`* QQ群: 256076853, 158716820(已满)`
update readme 2015-10-27 23:17:15 +08:00			`* [Leanote Google Group](https://groups.google.com/forum/#!forum/leanote)`
update readme 2014-12-07 22:02:01 +08:00