Joplin

Joplin is an open-source note-taking and to-do application designed to manage large volumes of notes organized into notebooks.

Key Features:

• Markdown-based: All notes are stored in Markdown format, allowing for easy editing in external text editors.
• Offline-first: Data is stored locally on your device, ensuring accessibility without an internet connection.
• Searchable: Full-text search is supported across all platforms.
• Extensible: The application supports custom themes and plugins.
• Cross-platform: Available on Windows, Linux, macOS, Android, and iOS.
• Web Clipper: Browser extensions for Firefox and Chrome allow you to save web pages and screenshots directly to Joplin.

Joplin Server Business (JSB) is a self-hosted synchronization server designed for organizations that require private and secure data management. It allows teams to collaborate on notebooks, manage multiple users, and publish notes to the internet or an intranet.

Key features include:

• Team Management: Centralized dashboard to manage users and teams.
• Collaboration: Shared notebooks with granular permissions (view-only or edit).
• Publishing: Ability to publish notes for browser viewing with customizable branding (logos, text, and colors).
• Email to Note: Save emails directly to the server by forwarding them to a dedicated address (requires mail infrastructure).
• Security: End-to-end encryption and full open-source transparency.
• Extensibility: Support for plugins, custom themes, and the Extension API for custom workflows.

This package is a fork of react-native-alarm-notification specifically maintained for use within the Joplin ecosystem. It includes bugfixes and improvements for Android.

While it supports core alarm functionalities such as setting and dismissing alarms, and configuring alarm text and icons, it is not fully compatible with the original emekalites/react-native-alarm-notification package due to these Joplin-specific optimizations.

The Joplin Plugin API allows developers to extend the application by adding new features directly to Joplin. You can use plugins to modify application behavior and introduce new capabilities.

To understand the full scope of what can be achieved with a plugin, consult the Plugin API Overview.

Joplin Cloud is a synchronization service designed to automatically sync notes across all your devices. It provides several advanced features beyond standard synchronization:

• Note Publishing: You can publish a note to the internet to share it with others. The published version updates automatically whenever you modify the note.
• Notebook Collaboration: You can share a notebook with other Joplin Cloud users, granting them full access to read, change, or add notes, images, and documents.
• Improved Sync Performance: Because it is developed specifically for Joplin, it offers faster synchronization and lower resource consumption compared to other sync options.
• Email-to-Note: You can forward emails to a dedicated Joplin Inbox address to create notes, making it easier to store and retrieve important information.

Joplin is a free and open-source note-taking application available as a desktop, mobile, and terminal application. The core functionality is shared across all platforms, with differences noted in specific guides.

The desktop interface is organized into three main columns:

1. Sidebar: Contains your list of notebooks, tags, and synchronization status.
2. Note List: Displays the current list of notes (e.g., notes within a selected notebook, notes with a selected tag, or search results).
3. Note Editor: The area where you write and view notes.

You can switch between a Rich Text Editor and a Markdown Editor by clicking the Toggle Editor button in the top right corner. Additionally, you can configure an external text editor (like Typora) to modify notes directly.

The utils package provides generic utility functions designed to be imported by any other package within the Joplin ecosystem.

To maintain a lightweight footprint, this package is strictly decoupled from other core Joplin packages. It has no dependencies on lib, renderer, or other internal modules. This design allows developers to include it in environments like Docker images without pulling in unnecessary heavy dependencies, ensuring the resulting images are as small as possible.

This repository serves as a template for creating new Joplin plugins. The core structure consists of two primary files:

• /src/index.ts: The entry point for your plugin's source code.
• /src/manifest.json: The plugin manifest containing metadata such as the plugin name and version.

The project is configured for TypeScript by default, but can be adapted to use plain JavaScript.