diff --git a/README.md b/README.md index 295d577..782b27c 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,23 @@ --- notebook: - owner: shd101wyy - name: "Welcome notebook" -tags: - - welcome + owner: shd101wyy + name: 'Welcome notebook' +aliases: [] pinned: true created: 2020-03-26T11:41:38.680Z -modified: 2020-06-28T14:17:12.166Z +modified: 2021-02-28T14:40:53.982Z --- -# 📝 Welcome to Crossnote 交叉笔记 (beta) +# 📝 Welcome to Crossnote 交叉笔记 > It is recommended to view this notebook in [Crossnote](https://crossnote.app/?repo=https%3A%2F%2Fgithub.com%2F0xGG%2Fwelcome-notebook.git&branch=master&filePath=README.md). > This notebook is hosted on GitHub: https://github.com/0xGG/welcome-notebook [https://crossnote.app](https://crossnote.app) -**Attention: Breaking updates coming soon. Please check [this GitHub issue](https://github.com/0xGG/crossnote/issues/129) for more information.** - 😎 More information can be found below: -- [English](./enUS/README.md) -- [简体中文](zhCN/README.md) - -We also offer a Visual Studio Code extension (Still under development): [0xGG/vscode-crossnote](https://github.com/0xGG/vscode-crossnote) | [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=shd101wyy.crossnote) +- [English](./enUS/Introduction.md) +- [简体中文](zhCN/介绍.md) diff --git a/USA.md b/USA.md new file mode 100644 index 0000000..1bfb923 --- /dev/null +++ b/USA.md @@ -0,0 +1,10 @@ +--- +aliases: + - 'United States' + - 'United States of America' + - 美国 + - 米国 +created: 2021-02-28T14:14:51.885Z +modified: 2021-02-28T14:16:04.814Z +--- +https://en.wikipedia.org/wiki/United_States \ No newline at end of file diff --git a/demo/abc.md b/demo/abc.md deleted file mode 100644 index e41d417..0000000 --- a/demo/abc.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -tags: [] -created: 2020-04-03T10:28:44.338Z -modified: 2020-04-24T08:41:38.734Z ---- - -# Demo - abc notation - -> This feature is currently disabled - - diff --git a/demo/diagrams.md b/demo/diagrams.md index 8702f1a..a2d61af 100644 --- a/demo/diagrams.md +++ b/demo/diagrams.md @@ -1,11 +1,9 @@ --- -tags: - - demo +aliases: [] created: 2020-03-26T13:51:27.743Z -modified: 2020-03-26T14:27:57.864Z +modified: 2021-02-28T14:28:41.983Z --- -# Diagrams Mermaid: diff --git a/demo/encrypted.md b/demo/encrypted.md deleted file mode 100644 index 81d718c..0000000 --- a/demo/encrypted.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -tags: - - demo -encryption: - title: "This note is encrypted" -created: 2020-03-26T15:29:43.621Z -modified: 2020-03-26T15:33:29.542Z ---- - -U2FsdGVkX1/j7l6anuzkuFfQmkQOW/on1i0jpmIVQqmdcaxGPBg1GQWztLleD1K0ozEZPHRVrgT1ie4tzx14WZ/EQu8ZnURdW0XCv/dSNFcJVmWP7/bJVpYLoCDajIjzyf1zau6NNItHclNwtA8nWA== diff --git a/demo/unnamed_0ii4wnlal.md b/demo/unnamed_0ii4wnlal.md deleted file mode 100644 index 4d42bbe..0000000 --- a/demo/unnamed_0ii4wnlal.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -tags: [] -created: 2020-04-03T10:26:00.020Z -modified: 2020-05-01T03:18:52.012Z ---- - -# Demo - netease - -> seems to have bug and disabled for now - - diff --git a/development/plans.md b/development/plans.md deleted file mode 100644 index 42a0323..0000000 --- a/development/plans.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -tags: - - development -created: 2020-03-26T14:10:52.143Z -modified: 2020-06-14T14:09:54.611Z ---- - -# Development plans - - - -> Actually the Kanban syntax might be changed in the future. Seems like it has a lot of bugs - -You'd better view this note in fullscreen mode by clicking the fullscreen icon button in toolbar (next to the print button) - - diff --git a/enUS/README.md b/enUS/Introduction.md similarity index 81% rename from enUS/README.md rename to enUS/Introduction.md index 1511fdc..453f671 100644 --- a/enUS/README.md +++ b/enUS/Introduction.md @@ -1,11 +1,10 @@ --- -tags: - - introduction +aliases: [] +favorited: true created: 2020-03-26T12:45:15.481Z -modified: 2020-05-15T04:14:59.340Z +modified: 2021-02-28T15:00:32.594Z --- - -# 📝 Welcome to Crossnote (beta) +# 📝 Welcome to Crossnote > It is recommended to view this notebook in [crossnote](https://crossnote.app/?repo=https%3A%2F%2Fgithub.com%2F0xGG%2Fwelcome-notebook.git&branch=master&filePath=README.md). @@ -13,15 +12,15 @@ modified: 2020-05-15T04:14:59.340Z ## 🔭 Introduction -**Crossnote** is probably the world's first markdown notes reader & editor progressive web application that works offline ~~perfectly~~ (maybe not yet but soon 😂) and supports syncing with arbitrary git repository right inside your browser. +**Crossnote** is a markdown notes reader & editor progressive web application that works offline ~~perfectly~~ (maybe not yet but soon 😂) and supports syncing with arbitrary git repository right inside your browser. It also supports opending and editing your local files. -Crossnote is heavily inspired by [Markdown Preview Enhanced](https://github.com/shd101wyy/markdown-preview-enhanced), [Google Keep](https://keep.google.com), [Google Docs](https://docs.google.com), [Quip](https://quip.com), [Notion](https://www.notion.so), [GitBook](https://gitbook.com), [Notable](https://github.com/notable/notable), [Evernote](https://evernote.com/), and [Bear](https://bear.app/). +Crossnote is heavily inspired by [Markdown Preview Enhanced](https://github.com/shd101wyy/markdown-preview-enhanced), [Google Keep](https://keep.google.com), [Google Docs](https://docs.google.com), [Quip](https://quip.com), [Notion](https://www.notion.so), [GitBook](https://gitbook.com), [Notable](https://github.com/notable/notable), [Evernote](https://evernote.com/), [Bear](https://bear.app/), [RoamResearch](https://roamresearch.com/). -Unlike [Crossnote (_alpha_)](https://github.com/0xGG/crossnote/blob/master/README.alpha.md), which is completely cloud based, **Crossnote (beta)** aims to be offline first. That is, your data is stored entirely in your browser. We won't collect your notes and credentials to our server. **You own your data**. +Unlike [Crossnote (_alpha_)](https://github.com/0xGG/crossnote/blob/master/README.alpha.md), which is completely cloud based, **Crossnote** aims to be offline first. That is, your data is stored entirely in your browser. We won't collect your notes and credentials to our server. **You own your data**. The front-end of crossnote project is completely open sourced on GitHub [0xGG/crossnote](https://github.com/0xGG/crossnote). It is released under **AGPL3**. Any contributions or suggestions would be very helpful for the growth of the project. -You can easily synchronize your notebooks with arbitrary git repositories thanks to the awesome [isomorphic-git](https://github.com/isomorphic-git/isomorphic-git) project that makes running git possible right inside this web application. +You can easily synchronize your notebooks with arbitrary git repositories thanks to the awesome [isomorphic-git](https://github.com/isomorphic-git/isomorphic-git) project that makes running git possible right inside this web application. The wonderful [File System Access API](https://web.dev/file-system-access/) also makes it possible to open and edit your local files. This application is still under development, and its production website is currently running on a Vultr VPS with only 8GB ram located in Los Angeles. @@ -39,8 +38,9 @@ On iOS devices (iPhone and iPad), I would suggest you to try [crossnote](https:/ - 📊 Different kinds of diagrams. See [the demo here](/demo/diagrams.md). - ~~⌨️ Collaborative editing~~ This feature is supported in _alpha_ before but not in current _beta_ version. We will bring collaborative editing (probably in P2P way) back in the future. - 🖼 Slides follows the same specs as in [Markdown Preview Enhanced](https://shd101wyy.github.io/markdown-preview-enhanced/#/presentation). See [the demo from MPE here](/demo/presentation.md) -- 🏷️ Indefinitely nestable tags #why/so/cool. (YES We like what [Bear](https://bear.app) and [Notable](https://github.com/notable/notable) did!) -- 🔐 Builtin encryption support by AES algorithm that protects your note with password. For example, [this note](/demo/encrypted.md) was encrypted with password `123456` 🙈. +- 🏷️Backlinks support. + - 🕸️ Display the relationship of your notes in graph view. + - 🗒️ Set up multiple aliases for your note. For example [[../USA.md|USA]], [[../USA.md|United States]], [[../USA.md|美国]] all points to the same note. - 🖨️ Print your note to PDF. We are planning to support to export to more types of files in the future! - 📤 Synchronize your notebook with arbitrary git repository. (🙋Please read the tutorial [here](/enUS/tutorial.md)) - 🛠 Widgets support that powers your markdown note. Type `/` for commands and play with the widgets. @@ -70,14 +70,15 @@ You can create infinite number of cloud widgets during the _beta testing_ stage. We provide a short tutorial that guides you to create your first notebook with a git repository on GitHub [Here](/enUS/tutorial.md). -## :spider_web: Web Clipper +## 🕸️ Web Clipper We haven't officially offered any web clipper support, but you could use the web clipper provided by Quiver to convert a webpage to markdown then copy it to Crossnote. - [Quiver Web Clipper - Chrome Web Store](https://chrome.google.com/webstore/detail/quiver-web-clipper/hcnffmpopoelpggikahccdfenoobjigj) - [Quiver Web Clipper - Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/quiver-web-clipper/) -## 🌍 Share you notebooks with the public +## 🌍 ~~Share you notebooks with the public~~ +>👆 This feature is currently disabled Yes you can publish your notebook to the public in `Explore` section. We currently only support publishing the notebook from a public repository on GitHub, GitLab, Gitea, or Gitea. We only collect README.md file data. @@ -85,7 +86,7 @@ Only the `README.md` data will be collected. ## 📅 Development plans -See the [Development Plans](/development/plans.md). +See the [Development Plans](https://github.com/0xGG/crossnote/projects/1). ## 📖 Development doc @@ -103,8 +104,6 @@ If you are interested in this project and want to get more involved (or even hel You can also join our discussion group on Wechat: -![webwxgetmsgimg](https://i.loli.net/2020/07/16/uk7MFJVp8O2DwEL.jpg) - -Finally, I hope the Coronavirus outbreaks happened in 2020 will end soon 🙏. +![](https://i.loli.net/2021/02/28/7nYsui2gcNyXOlo.jpg) Thank you! diff --git a/enUS/tutorial.md b/enUS/tutorial.md index 3bbab14..b968678 100644 --- a/enUS/tutorial.md +++ b/enUS/tutorial.md @@ -1,10 +1,8 @@ --- -tags: - - tutorial +aliases: [] created: 2020-03-28T07:52:59.238Z -modified: 2020-03-28T08:37:27.812Z +modified: 2021-02-28T14:39:04.307Z --- - # Tutorial > This tutorial assumes that you are hosting your cloud notebook on a GitHub repository. diff --git a/zhCN/README.md "b/zhCN/\344\273\213\347\273\215.md" similarity index 81% rename from zhCN/README.md rename to "zhCN/\344\273\213\347\273\215.md" index 2c51a84..27a6b53 100644 --- a/zhCN/README.md +++ "b/zhCN/\344\273\213\347\273\215.md" @@ -1,12 +1,11 @@ --- -tags: - - introduction - - why/so/cool +aliases: [] +favorited: true created: 2020-03-26T13:04:29.042Z -modified: 2020-05-15T04:17:07.045Z +modified: 2021-02-28T15:00:44.739Z --- -# 📝 欢迎使用交叉笔记 (beta) +# 📝 欢迎使用交叉笔记 > 推荐在 [交叉笔记](https://crossnote.app/?repo=https%3A%2F%2Fgithub.com%2F0xGG%2Fwelcome-notebook.git&branch=master&filePath=README.md) 中查看这个笔记本。 @@ -14,15 +13,15 @@ modified: 2020-05-15T04:17:07.045Z ## 🔭 介绍 -**Crossnote 交叉笔记** 可能是这个世界上第一款可离线工作并且支持在浏览器中直接与 git 仓库进行同步的的 markdown 笔记阅读器 & 编辑器。 +**Crossnote 交叉笔记** 是一款可离线工作并且支持在浏览器中直接与 git 仓库进行同步的的 markdown 笔记阅读器 & 编辑器。它同时还支持打开并编辑你的本地文件。 -交叉笔记受到了这些产品的启发： [Markdown Preview Enhanced](https://github.com/shd101wyy/markdown-preview-enhanced)，[Google Keep](https://keep.google.com)，[Google Docs](https://docs.google.com)，[Quip](https://quip.com)，[Notion](https://www.notion.so)，[GitBook](https://gitbook.com)，[Notable](https://github.com/notable/notable)，[Evernote](https://evernote.com/)，以及 [Bear](https://bear.app/)。 +交叉笔记受到了这些产品的启发： [Markdown Preview Enhanced](https://github.com/shd101wyy/markdown-preview-enhanced)，[Google Keep](https://keep.google.com)，[Google Docs](https://docs.google.com)，[Quip](https://quip.com)，[Notion](https://www.notion.so)，[GitBook](https://gitbook.com)，[Notable](https://github.com/notable/notable)，[Evernote](https://evernote.com/)，以及 [Bear](https://bear.app/), [RoamResearch](https://roamresearch.com)。 -不同于[交叉笔记 (_alpha_)](https://github.com/0xGG/crossnote/blob/master/README.alpha.md)这款完全基于云端的笔记软件，**交叉笔记 (beta)** 的目标是离线第一。你的所有数据将会保存于你的浏览器中。我们不会上传你的笔记和密钥到我们的服务器。**你拥有的你的数据的控制权**。 +不同于[交叉笔记 (_alpha_)](https://github.com/0xGG/crossnote/blob/master/README.alpha.md)这款完全基于云端的笔记软件，**交叉笔记** 的目标是离线第一。你的所有数据将会保存于你的浏览器中。我们不会上传你的笔记和密钥到我们的服务器。**你拥有的你的数据的控制权**。 交叉笔记项目的前端是完全在 GitHub 上开源的 [0xGG/crossnote](https://github.com/0xGG/crossnote)。它使用的是 **AGPL3** 协议。任何的代码贡献或者项目建议都会对这个项目的发展产生很大的助力。 -你可以非常方便地将你的笔记本和任意的 git 仓库进行同步。这点归功于一个炫酷的项目 [isomorphis-git](https://github.com/isomorphic-git/isomorphic-git)。它使得直接在浏览器中运行 git 命令成为了可能。 +你可以非常方便地将你的笔记本和任意的 git 仓库进行同步。这点归功于一个炫酷的项目 [isomorphis-git](https://github.com/isomorphic-git/isomorphic-git)。它使得直接在浏览器中运行 git 命令成为了可能。同时 [File System Access API](https://web.dev/file-system-access/) 使得打开并编辑你的本地文件成为可能。 交叉笔记项目目前还在开发中，并且它的生产环境只部署于位于洛杉矶的一个只有 8GB 内存的 Vultr 主机上。 @@ -40,10 +39,11 @@ modified: 2020-05-15T04:17:07.045Z - 📊 各种各样的图表支持. 查看 [演示](/demo/diagrams.md)。 - ~~⌨️ 协同编辑~~ 这个功能原来在 _alpha_ 版本中是支持的，但是当前的 _beta_ 版本取消了支持。我们未来会把这个功能加回来（可能用 P2P 的实现方式）。 - 🖼 和 [Markdown Preview Enhanced](https://shd101wyy.github.io/markdown-preview-enhanced/#/presentation) 中相同标准的幻灯片制作。查看 [MPE 中的演示](/demo/presentation.md)。 -- 🏷️ 无限嵌套式标签 #why/so/cool 。（没错我们喜欢 [Bear](https://bear.app) 和 [Notable](https://github.com/notable/notable) 的设计思路） -- 🔐 内置 AES 算法加密，支持你设置密码保护你的笔记。例如[这个加密笔记](/demo/encrypted.md)的密码是 `123456` 🙈。 +- 🏷️ 反向链接的支持。 +- 🕸️ 在图形视图中展示你的笔记之间的关系网络。 + - 🗒️ 为你的笔记设立不同的别名。例如 [[../USA.md|USA]], [[../USA.md|美国]]，[[../USA.md|United States]] 都指向同一个笔记。 - 🖨️ 打印你的笔记为 PDF。我们在未来会支持更多的导出格式！ -- 📤 同步你的笔记本到任意的 git 仓库（🙋 教程请查看[这里](/zhCN/tutorial.md)） +- 📤 同步你的笔记本到任意的 git 仓库（🙋 教程请查看[这里](/zhCN/教程.md)） - 🛠 让你的笔记更加强健有力的挂件。输入 `/` 来显示命令并且尝试创建些你的挂件。 - `/timer` - Media @@ -69,16 +69,17 @@ modified: 2020-05-15T04:17:07.045Z ## 🙋 教程 -我们提供了一个简短的教程来引导你利用一个 GitHub 上的仓库来创建你的第一个笔记本。请查看[这里](/zhCN/tutorial.md)。 +我们提供了一个简短的教程来引导你利用一个 GitHub 上的仓库来创建你的第一个笔记本。请查看[这里](/zhCN/教程.md)。 -## :spider_web: Web Clipper +## 🕸️ Web Clipper 我们尚未提供官方的 Web Clipper 支持，但是你可以暂时使用 Quiver 的 Web Clipper 来剪切网页为 Markdown 然后拷贝至 Crossnote。 - [Quiver Web Clipper - Chrome Web Store](https://chrome.google.com/webstore/detail/quiver-web-clipper/hcnffmpopoelpggikahccdfenoobjigj) - [Quiver Web Clipper - Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/quiver-web-clipper/) -## 🌍 和大众分享你的笔记本 +## ~~🌍 和大众分享你的笔记本~~ +>👆 这个功能暂时被取消了 是的我们支持用户在 `探索` 部分发布自己想要公开的笔记本。 我们目前仅支持从 GitHub、GitLab、Gitea 或码云的公共仓库发布笔记本。 @@ -86,7 +87,7 @@ modified: 2020-05-15T04:17:07.045Z ## 📅 开发计划 -查看 [Development Plans](/development/plans.md)。 +查看 [Development Plans](https://github.com/0xGG/crossnote/projects/1)。 ## 📖 开发文档 @@ -104,8 +105,6 @@ modified: 2020-05-15T04:17:07.045Z 你也可以选择加入我们的微信讨论群 -![webwxgetmsgimg](https://i.loli.net/2020/07/16/uk7MFJVp8O2DwEL.jpg) - -最后，希望 2020 年发生的疫情早日结束 🙏。 +![](https://i.loli.net/2021/02/28/7nYsui2gcNyXOlo.jpg) 谢谢！ diff --git a/zhCN/tutorial.md "b/zhCN/\346\225\231\347\250\213.md" similarity index 97% rename from zhCN/tutorial.md rename to "zhCN/\346\225\231\347\250\213.md" index 39ffe5b..09251bb 100644 --- a/zhCN/tutorial.md +++ "b/zhCN/\346\225\231\347\250\213.md" @@ -1,12 +1,8 @@ --- -tags: - - tutorial +aliases: [] created: 2020-03-28T08:22:40.925Z -modified: 2020-03-28T08:37:34.003Z +modified: 2021-02-28T14:38:49.091Z --- - -# 教程 - > 这个教程假设你的笔记本是保存在一个 GitHub 上的仓库中的。 > 理论上来讲，所有的 git 仓库都使用方法都一样，例如 GitLab，码云，或者你自己搭建的等。