Giter VIP home page Giter VIP logo

lightnote's Introduction

LightNote

LightNote has been developed utilizing SvelteKit, Tiptap, and shadcn/ui to ensure accessibility even in offline environments.

Documents are basically stored in LocalStorage, and if you wish to save them permanently, you should use the provided save function to store them as HTML files. Additionally, you can upload these files to continue editing.

If you want more features, please visit the Tiptap documentation and extend the functionality through extensions.


Usage

You can use LightNote via the following link: https://code0xff.github.io/LightNote

This link will take you to the Github page where LightNote is deployed, allowing you to start using it immediately.


Collaboration

LightNote supports collaboration features. LightNote utilizes Tiptap's Collaboration extension and supports cross-device connections through WebSocket, requiring a Hocuspocus server for relay. The Hocuspocus server can either be hosted directly or leverage a third-party service that provides the necessary functionality. If Node.js is installed on the device, enter the following command to start the Hocuspocus server.

npx @hocuspocus/cli --port 1234 --sqlite

If it is not possible to provide the hosting endpoint over HTTPS, you can use the ngrok proxy to expose it via HTTPS. After signing up for ngrok and obtaining the token, use the command below to expose the previously launched server over HTTPS.

ngrok http http://localhost:1234

Finally, connect to the relay server using the ngrok proxy address and workspace name.

https://code0xff.github.io/LightNote?endpoint={proxy_url}&workspace={workspace}

Now, collaboration mode is active!


License

LightNote is released under the MIT License. See LICENSE for details.

lightnote's People

Contributors

code0xff avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.