Repository files navigation

• 🚀 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

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! 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 thatdata loss is possible so we recommendautomated backups orregular 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 tohttps://test.logseq.com/.
• To try the latest desktop version, login to Github and go tohttps://github.com/logseq/logseq/actions/workflows/build-desktop-release.yml and click on the latest release. Scroll to the bottom and under theArtifacts section download the artifact for your operating system.
• To report bugs, please file them athttps://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.

Logseq is aknowledge management andcollaboration platform. It focuses onprivacy,longevity, anduser control. Logseq offers a range ofpowerful tools forknowledge management,collaboration,PDF annotation, andtask management with support for multiple file formats, includingMarkdown andOrg-mode, andvarious features for organizing and structuring your notes.

Logseq'sWhiteboard feature lets you organize your knowledge and ideas using a spatialcanvas withshapes,drawings,website embeds, andconnectors. You canvisually group andlink yournotes and external media (such asvideos andimages), 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 ofplugins andthemes that enable a wide range of workflows andcustomization 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.

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! 🎉

• Website:logseq.com
• Documentation:docs.logseq.com
  • FAQ page:Logseq Docs: FAQ
• Blog:blog.logseq.com
  • Please visit ourAbout page for the latest updates.
• Logseq Hub:hub.logseq.com
• 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:discord.gg/logseq
  • 中文 Discord

If you find Logseq useful and want to help us keep the project growing, please consider supporting our contributors onOpen 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.

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 theLogseq Forum: FeatureRequests 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!

Logseq provides a plugin API that enables developers to create custom plugins and extend the functionality of Logseq. The plugin API documentation is available atplugins-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!

To start contributing to Logseq, please readCONTRIBUTING.md.There are ways to contributewith code andwithout code. We welcome allcontributions, big or small, and we appreciate your time and effort in helpingus improve Logseq. We look forward to your contributions 🚀

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

In addition to these guides, you can also find other helpful resources in thedocs/ folder, such as theGuide for Contributing to Translations, theDocker Web App Guide and themobile development guide

Logseq is inspired by several unique tools and projects, includingRoam Research,Org Mode,TiddlyWiki,Workflowy, andCuekeeper.

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 parsermldoc
• isomorphic-git - A pure JavaScript implementation of Git for NodeJS and web browsers
• SCI - A Small Clojure Interpreter

We want to express our sincere gratitude to ourOpen Collectivesponsors,backers, andcontributors. 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!

[Become a sponsor]