Getting Started

Follow these instructions to run project locally.

Prerequisites

Follow these commands to run project successfully.

• npm

  npm install npm@latest -g
  

  • or install yarn

Installation

1. Clone the repo

   git clone https://github.com/magnusmage/magescribe.git
   

2. Install packages in root directory

   npm install
   npm run start-server
   

3. All done 😄😄

🎁 Features

• Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (see cloning)
• Rich WYSIWYG note editing including e.g. tables, images and math with markdown autoformat
• Support for editing notes with source code, including syntax highlighting
• Fast and easy navigation between notes, full text search and note hoisting
• Seamless note versioning
• Note attributes can be used for note organization, querying and advanced scripting
• Synchronization with self-hosted sync server
  • there's a 3rd party service for hosting synchronisation server
• Sharing (publishing) notes to public internet
• Strong note encryption with per-note granularity
• Sketching diagrams with built-in Excalidraw (note type "canvas")
• Relation maps and link maps for visualizing notes and their relations
• Scripting - see Advanced showcases
• REST API for automation
• Scales well in both usability and performance upwards of 100 000 notes
• Touch optimized mobile frontend for smartphones and tablets
• Night theme
• Evernote and Markdown import & export
• Web Clipper for easy saving of web content

Check out awesome-trilium for 3rd party themes, scripts, plugins and more.

🏗 Builds

Magescribe is provided as either desktop application (Linux and Windows) or web application hosted on your server (Linux). Mac OS desktop build is available, but it is unsupported.

• If you want to use magescribe on the desktop, download binary release for your platform from latest release, unzip the package and run magescribe executable.
• If you want to install Magescribe on server, follow this page.
  • Currently only recent Chrome and Firefox are supported (tested) browsers.

Magescribe is also provided as a Flatpak:

Usage

For additional usage read docs.

Contributing

For contributions greatly appreciated.

1. Clone the Project
2. Create your Feature Branch (git checkout -b feature/NewFeature)
3. Commit your Changes (git commit -m 'Add: NewFeature')
4. Push to the Branch (git push origin feature/NewFeature)
5. Open a Pull Request

How to commit

For commit use prefixes in commit messages to provide context and clarity about the changes made to the code. This convention involves using short, descriptive prefixes such as

• Add: for new features
• Update: for modifications to existing functionality
• Improvement: for code improvements
• Fix: for bug fixes
• Integration: for integration
• Remove: for deleting code or features
• Docs: for documentation updates

By following a consistent commit message convention, developers can efficiently track changes to the code and easily understand the navigate of modifications made over time.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

https://magnusmage.com/

Copyright © 2023 — https://magnusmage.com/