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.
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.
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.
Now, collaboration mode is active!
LightNote is released under the MIT License. See LICENSE for details.