logseq

Logseq

A privacy-first, open-source platform for knowledge management and collaboration

<a href="https://logseq.com">Home Page</a> |
<a href="https://blog.logseq.com/">Blog</a> |
<a href="https://docs.logseq.com/">Documentation</a> |
<a href="https://trello.com/b/8txSM12G/roadmap">Roadmap</a>

Table of Contents

• 🚀 Database Version
• 🤔 Why Logseq?
• 👀 How can I use it?
• 📚 Learn more
• 🫶 Support Logseq Development
• 💡 Feature requests
• 🔌 Plugin API
• 🌟 Contributing to Logseq
  • 🛠️ Setting Up a Development Environment
• ✨ Inspiration
• 🙏 Thank You

🚀 Database Version

The Database version (DB version) of Logseq introduces DB graphs while maintaining support for file graphs. See this page to get an overview of the main features for DB graphs. If you are an existing user, see changes with the DB version. The DB version has its own new mobile app (on iOS, with Android coming soon)! To participate in the mobile app alpha, please complete this brief form. The DB version also has a new sync approach, RTC (Real Time Collaboration)! You can use it to sync graphs between multiple devices or collaborate with others. To participate in the RTC alpha, please fill out this form.

The DB version is in beta status while the new mobile app and RTC is in alpha. This means that data loss is possible so we recommend automated backups or regular SQLite DB backups. When using DB graphs, we recommend you create a dedicated test graph and choose one project that’s not crucial for you. When using file graphs, data corruption is possible as some file content can be duplicated. We only recommend using it with file graphs if you make regular backups with git.

To get started with the DB version:

• To try the latest web version, go to https://test.logseq.com/.
• To try the latest desktop version, login to Github and go to https://github.com/logseq/logseq/actions/workflows/build-desktop-release.yml and click on the latest release. Scroll to the bottom and under the Artifacts section download the artifact for your operating system.
• To report bugs, please file them at https://github.com/logseq/db-test/issues.
• For feature or enhancement requests, please file them on Discord on the #db-feedback channel.
• For discussion, see the #db-chat channel in Discord.

🤔 Why Logseq?

Logseq is a knowledge management and collaboration platform. It focuses on privacy, longevity, and user control. Logseq offers a range of powerful tools for knowledge management, collaboration, PDF annotation, and task management with support for multiple file formats, including Markdown and Org-mode, and various features for organizing and structuring your notes.

Logseq's Whiteboard feature lets you organize your knowledge and ideas using a spatial canvas with shapes, drawings, website embeds, and connectors. You can visually group and link your notes and external media (such as videos and images), enabling visual thinkers to compose, remix, annotate, and connect content from their knowledge base and emerging thoughts in a new way.

In addition to its core features, Logseq has a growing ecosystem of plugins and themes that enable a wide range of workflows and customization options. Mobile apps are also available, providing access to most of the features of the desktop application. Whether you're a student, a professional, or anyone who values a clear and organized approach to managing your ideas and notes, Logseq is an excellent choice for anyone looking to improve their productivity and streamline their workflow.

    <img src="https://img.shields.io/badge/Download_Logseq-100000?style=for-the-badge&logo=flatpak&logoColor=white&labelColor=002b36&color=85c8c8"
        align="right"
        alt="Download Logseq"/></a>

👀 How can I use it?

To start using Logseq, follow these simple steps:

1. Download the latest version of Logseq
2. Install Logseq on your device and launch the application
3. Start writing ✍️

That's it! You can now enjoy the benefits of using Logseq to streamline your workflow, manage your projects, and stay on top of your goals. Have fun! 🎉

Linux users: Use the automated installer script for the best experience:

   # Download and run the installer
   curl -fsSL https://raw.githubusercontent.com/logseq/logseq/master/scripts/install-linux.sh | bash
   
   # Or install a specific version
   curl -fsSL https://raw.githubusercontent.com/logseq/logseq/master/scripts/install-linux.sh | bash -s -- 0.10.14
   
   # For user-specific installation (no root required)
   curl -fsSL https://raw.githubusercontent.com/logseq/logseq/master/scripts/install-linux.sh | bash -s -- --user

📚 Learn more

• Website: logseq.com
• Documentation: docs.logseq.com
  • FAQ page: Logseq Docs: FAQ
• Blog: blog.logseq.com
  • Please visit our About page for the latest updates.
• Forum: discuss.logseq.com - Where we answer questions, discuss workflows, and share tips
  • FAQ forum section: Logseq Forum: FAQ
• Awesome Logseq - Awesome Logseq extensions and resources created by the community <3
• Twitter: @Logseq
• Discord: https://discord.com/invite/KpN4eHY
  • 中文 Discord

🫶 Support Logseq Development

If you find Logseq useful and want to help us keep the project growing, please consider supporting our contributors on Open Collective. Your support shows our contributors that their efforts are appreciated and motivates them to continue their excellent work. Every contribution, no matter how small, helps us keep improving Logseq.

💡 Feature requests

We value your input on improving Logseq and making it more useful for you. If you have any ideas or feature requests, please share them in the Logseq Forum: Feature Requests section.

Your feedback helps us understand our users' needs and prioritize the features that matter most to you. We appreciate your time and effort in sharing your thoughts with us.

We appreciate your support, and we look forward to hearing your ideas!

🔌 Plugin API

Logseq provides a plugin API that enables developers to create custom plugins and extend the functionality of Logseq. The plugin API documentation is available at plugins-doc.logseq.com, where you can find everything needed to get started with plugin development.

We value your feedback and suggestions on how to improve our documentation. Please do not hesitate to contact us with any comments or questions. Your input helps us to provide a better experience for our users and developers.

Thank you for using Logseq, and we look forward to seeing what you create with our plugin API!

🌟 Contributing to Logseq

To start contributing to Logseq, please read CONTRIBUTING.md. There are ways to contribute with code and without code. We welcome all contributions, big or small, and we appreciate your time and effort in helping us improve Logseq. We look forward to your contributions 🚀

🛠️ Setting Up a Development Environment

If you want to set up a development environment for the Logseq web or desktop app, please refer to the Develop Logseq guide for macOS/Linux users and the Develop Logseq on Windows guide for Windows users.

In addition to these guides, you can also find other helpful resources in the docs/ folder, such as the Guide for Contributing to Translations, the Docker Web App Guide and the mobile development guide

✨ Inspiration

Logseq is inspired by several unique tools and projects, including Roam Research, Org Mode, TiddlyWiki, Workflowy, and Cuekeeper.

We owe a huge debt of gratitude to the developers and creators of these projects, and we hope that Logseq can continue to build on their innovative ideas and make them accessible to a broader audience.

Thank you to all those who inspire us, and we look forward to seeing what the Logseq community will create with this tool!

Logseq is also made possible by the following projects:

• Clojure & ClojureScript - A dynamic, functional, general-purpose programming language
• DataScript - An immutable database and Datalog query-engine for Clojure, ClojureScript and JS
• OCaml & Angstrom, for the document parser mldoc
• isomorphic-git - A pure JavaScript implementation of Git for NodeJS and web browsers
• SCI - A Small Clojure Interpreter

🙏 Thank You

We want to express our sincere gratitude to our Open Collective sponsors, backers, and contributors. Your support and contributions allow us to continue developing and improving Logseq. Thank you for being a part of our community and helping us make Logseq the best it can be!

💎 Sponsors

[Become a sponsor]

🌟 Contributors