Please read official documents here

进入官方文档地址

这是一个基于Web，跨多平台的开源、非盈利展示平台

你是否打算着手构建笔记系统，却无从下手。

你是否对现今的博客平台那简陋的样式、杂乱的广告感到厌倦，希望能有一个让人专注的写作展示的地方。

你是否有过想要整理自己的文章，却发现绑定在XX平台上，无法剥离。

如果你有过以上的经历，那么选择onebook就对了。

1. 提供一个干净整洁的笔记展示平台。在这里，你可以将自己的知识与代码展示给世界。
2. 支持Markdown解析和语法高亮，能够渲染markdown文本和相关代码。
3. 基于第三方git平台的。只需一个github账号，即可在onebook查看您的博客或项目。
4. 提供二维码和博客链接分享，方便别人了解您。
5. 针对用户提供收藏功能，可以在您的管理界面快速访问收藏的文章。

• 将onebook作为博客，记录文字、记录自己
• 构建自己的笔记系统，方便查看和使用
• 向他人展示，进行技术分享
• 用作宣传，通过onebook展示你的图书样章等

成为我们的用户，你还可以

• 对文章进行收藏，方便自己的查看
• 可以看到作者的更新，查看最新的内容

首先你需要一个git平台账号，同时你需要创建一个存放代码或者笔记的仓库。

如果你没有git平台相关的使用经验，可以查看Github tutorial进行学习。

onebook对markdown格式的笔记进行排版和样式渲染，你的笔记可以通过markdown进行编写。

如果你没有markdown相关的知识，可以查看：

>>> 了解Markdown基本用法

>>> 学习Markdown标准语法

1. 为了对你的笔记进行渲染，需要在你的仓库下放置一个名为book.json的文件
2. 配置你的book.json文件
   • summary: 必选项，这里是您要展示的文章目录
   • 文件夹（代表文章分类）需要使用{}格式
   • 文本文件（代表文章）：同一类下使用[]包裹。

For example（在书写的时候请去掉 // ...，这里仅仅为了方便说明）：

>>> 看看站长的book.json配置

{
    "author":"DongYuanxin", // 可选项
    "summary":{ // 必选项
        "NodeJs":[ // 一级目录
            "module.exports和exports.md" // 千万不要忘记文件后缀名
        ],
        "JavaScript":{
            "函数":[ // 多级目录
                "原型链妙用.md", // 此分类下的文章列表
                "调用模式.md",
                "闭包.md",
                "级联.md"
            ],
            "ES6":[ // 多级目录
                "Promise理解.md",
                "let的单独作用域.md",
                "理解const的“不变”.md"
            ]
        },
        "python":{
            "高级应用":[
                "三神器-迭代器、生成器和装饰器.md"
            ]
        }
    }
}

onebook 还强烈推荐你成为我们的用户，以进行更多功能的体验。成为我们的用户，你可以对喜欢的文章进行收藏，方便多次阅读， 将其加入到自身的知识库中，而不用花费时间在寻找用户笔记上面。