Skip to content

Commit

Permalink
doc: Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shd101wyy committed Feb 28, 2021
1 parent 804ba3b commit cfc8ecf
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 110 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.**

<!-- @crossnote.comment "id":"c53ea3f2-a7ab-44b9-b082-274573753207" -->

😎 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)
10 changes: 10 additions & 0 deletions USA.md
Original file line number Diff line number Diff line change
@@ -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
11 changes: 0 additions & 11 deletions demo/abc.md

This file was deleted.

6 changes: 2 additions & 4 deletions demo/diagrams.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
10 changes: 0 additions & 10 deletions demo/encrypted.md

This file was deleted.

11 changes: 0 additions & 11 deletions demo/unnamed_0ii4wnlal.md

This file was deleted.

16 changes: 0 additions & 16 deletions development/plans.md

This file was deleted.

33 changes: 16 additions & 17 deletions enUS/README.md → enUS/Introduction.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
---
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).
<!-- @crossnote.comment "id":"a53b8fc6-268d-405c-b65e-d2a4683ac277" -->

## 🔭 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.

Expand All @@ -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.
Expand Down Expand Up @@ -70,22 +70,23 @@ 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.
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

Expand All @@ -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!
6 changes: 2 additions & 4 deletions enUS/tutorial.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading

0 comments on commit cfc8ecf

Please sign in to comment.