getreu / tp-note

# Tp-Note: Markup enhanced granular note-taking **Save and edit your clipboard content as a note file** Overview of Tp-Note Tp-Note is a versatile note-taking tool designed for both desktop and console environments. It allows users to create, edit, and manage notes efficiently. Tp-Note is designed to bridge the gap between unstructured clipboard data and organized, local file storage. It is primarily built in Rust and follows a "file-centric" philosophy where the filename itself acts as a synchronized piece of metadata. This tool is ideal for users looking for a simple yet powerful way to manage their notes across different platforms. A more sophisticated example using the “Zettelkasten” scheme: Key Features • **Clipboard Integration**: Tp-Note can save and edit clipboard content as note files, making it easy to capture information quickly. • **Template System**: It uses customizable templates to synchronize note metadata with filenames, enhancing organization. • **Markdown Support**: Users can convert HTML content to Markdown. Notes are rendered from Markdown to HTML when viewed with Tp-Note's internal web server. • **File Management**: Notes can be created from existing files or directories, and users can easily navigate and edit their notes. Usage Examples | Action | Command Example | |-------------------------|----------------------| | Create a note from clipboard | (when clipboard contains text) | | Convert HTML to Markdown | \| | | Edit an existing note | | | Generate PDF from a note | \| | User review _On Tue, 2023-12-19 at 12:58 +1100, Dev Rain wrote:_ > _Found Tp-Note awhile back and it has become part of my daily workflow, > and indeed part of my daily note-taking life. I wanted to extend my > thanks; so thank you. > dev.rain_ Read more in [Tp-Note’s user manual], [Download Tp-Note] or visit the project page: [Tp-Note - Minimalistic note-taking]. --- Documentation User documentation: • Introductory video [Tp-Note - Most common use cases - YouTube] • Project page: [Tp-Note's project page], which you are reading right now, lists where you can download _Tp-Note_ and gives an overview of _Tp-Note_'s resources and documentation. • User manual: The user manual showcases how to best use use _Tp-Note_ and how to integrate it with your file manager. [Tp-Note user manual - html] [Tp-Note user manual - pdf] • Unix man-page: The Unix man-page is _Tp-Note_'s technical reference. Here you learn how to customize _Tp-Note_'s templates and how to change its default settings. [Tp-Note manual page - html] [Tp-Note manual page - pdf] • [Blogposts about Tp-Note] Developer documentation: • API documentation _Tp-Note_'s program code documentation targets mainly software developers. The code is split into a library [tpnote-lib] and the command line application [tpnote]. The advanced user may consult the [Tp-Note's config module documentation] and the [constants in the API documentation] which explain the various settings. Most of them can be customized through _Tp-Note_'s configuration file. Source code Repository: • [Tp-Note on Gitlab] • [Tp-Note on Github (mirror)] Distribution Download installer packages and binaries Tp-Note Microsoft Windows installer package • Installer package for Windows: [tpnote-latest-x86_64.msi] As this early version of the Windows installer is not signed yet, Windows will show the error message “Windows protected your PC”. As a work-around, when you click on the link “More info”, a ”Run anyway” button will appear allowing you to continue the installation process. In general, regardless of where a program comes from, I recommend checking every installable file with [VirusTotal]. Tp-Note Debian/Ubuntu installer package • Package compiled for Debian/Ubuntu: [x86_64-unknown-linux-gnu/debian/tpnote_latest_amd64.deb] Various binaries for Windows, MacOS and Linux • Binaries for Ubuntu-Linux 18.04, Windows, MacOS: • Open: [Releases - getreu/tp-note] • Open the latest release. • Open *assets*. • Download the packed executable for your operating system. • Installation: see below. • Precompiled binaries and packages for various architectures: • [binaries] • [packages] Tp-Note in official package repositories Tp-Note on NetBSD • An official package is available on NetBSD and other "pkgsrc" supported platforms. To install Tp-Note on NetBSD, simply use the native package manager: Tp-Note on NixOS • An official package is available on NixOS: Get Tp-Note with the Nix package manager • First install the Nix package manager available for Linux, MacOS and Windows (WSL2). Alternatively, for Linux there are also prebuilt Deb/Pacman/Rpm Nix installers available. Once you have the Nix package manager installed on your system, try out Tp-Note with: or follow installation instructions here: NixOS packages - tpnote Other resources • Copy the Unix man-page to : • [tpnote.1.gz] • Copy Tp-Note's icon to : • [tpnote.svg] Installation Tp-Note can be installed via a Windows installer package or by placing the binary directly on your desktop for easy access. It is recommended to integrate it into your file manager's context menu for convenience. Depending on the availability of installer packages for your operating system, the installation process is more or less automated. For Windows users the fully automated installation package [tpnote-latest-x86_64.msi] is available. After installation, click right on the desktop and select "Show more options", then "New Tp-Note" to get started. For more information, please consult the Distribution section above and the [Installation section] in _Tp-Note_'s manual. Upgrading While upgrading _Tp-Note_, new features may cause a change in _Tp-Notes_'s configuration file structure, e.g.: Mote, the configuration file backup is stored in the same directory as the last sourced configuration file, e.g. . If Tp-Note sources more than one configuration file, consider the possibility of synt…