Skip to content

Latest commit

 

History

History
109 lines (70 loc) · 7.26 KB

Introduction.md

File metadata and controls

109 lines (70 loc) · 7.26 KB
aliases favorited created modified
true
2020-03-26 12:45:15 UTC
2021-03-10 03:58:46 UTC

📝 Welcome to Crossnote

It is recommended to view this notebook in crossnote.

🔭 Introduction

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, Google Keep, Google Docs, Quip, Notion, GitBook, Notable, Evernote, Bear, RoamResearch, Obsidian.

Unlike Crossnote (alpha), 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. 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 project that makes running git possible right inside this web application. The wonderful File System Access API 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.

💾 Installation

On desktop computers and android devices, I would suggest you to try crossnote on Chrome. You can also create Shortcut to add it to your home screen (Menu (top right corner) -> More tools -> Create shortcut...).

On iOS devices (iPhone and iPad), I would suggest you to try crossnote on Safari and add the webpage to home screen. (How to create website shortcuts on iPhone and iPad).

🐞 However, the iOS will sometimes kill unactive background tasks, so running Crossnote in background sometimes has trouble. I haven't found any solutions...

⚗️ Functionalities

  • 🤩 Write your favorite notes in markdown. See basic markdown syntaxes.
  • 📊 Different kinds of diagrams. See the demo here.
  • ⌨️ 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. See the demo from MPE here
  • 🏷️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)
  • 🛠 Widgets support that powers your markdown note. Type / for commands and play with the widgets.
    • /timer
    • Media
    • /ocr
    • /kanban (beta)
    • /github_gist demo More widgets are coming out in the future.
  • 📖 Set up Wiki by adding SUMMARY.md file.

🌤 Crossnote cloud widgets

Crossnote cloud widgets are the special type of widgets that interact with Crossnote cloud server (😂 Proudly running on a Vultr VPS with only 8GB ram located in Los Angeles).

The first cloud widget that we supported in Crossnote is the /crossnote.comment widget 💬. This widget allows you to insert a comment system in your markdown note. For example:

You can create infinite number of cloud widgets during the beta testing stage. But in the future, there will be a number limit for different types of user accounts.

🙋 Tutorial

We provide a short tutorial that guides you to create your first notebook with a git repository on GitHub Here.

🕸️ 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.

🌍 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 doc

Check this.

😀 Interested in this project?

The crossnote project is actually currently developed by only one developer github/shd101wyy. And I hope more people can join the force in the future.

The goal of this project is to help me earn money💰. Yes, reality is cruel 😣. My goal is to earn $2000 USD with crossnote project by the end of 2020. As I am working as an indie developer, I need to making a living as well. I need income to help make this project alive, rent better servers, set up CDNs, etc.

My current plan is that all functionalities that can be done directly in browser will be free for sure, but those that have interactions with the backend server or have data to be stored in backend server will be charged.

If you are interested in this project and want to get more involved (or even help commercialize the project 😎), you can reach me either by my email [email protected] (well I don't check my email very often), or by my wechat(微信) shd101wyy, or by my Linkedin.

You can also join our discussion group on Wechat:

Thank you!