Logseq

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

Home Page | Blog | Documentation | Roadmap

🤔 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

🤔 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.

👀 How can I use it?

To start using Logseq, follow these simple steps:

Download the latest version of Logseq
Install Logseq on your device and launch the application
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! 🎉

📚 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.
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

🫶 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

🫶 Backers

Git Commit Hook Alternative

I just wanted to post a quick alternative to git-auto using a git post-commit hook and some gotchas I ran into while getting this set up. I like this approach because it ensures every commit is immediately pushed.

Creating `post-commit` hook

Ensure your logseq database is a git repository. This usually entails running git init in the root of the logseq directory.
Check "Enable Git auto commit" in the Logseq version control settings.
Create the file .git/hooks/post-commit relative to the root of the logseq repository with the following contents:
```
#!/bin/bash
git push
```

Potential Gotchas

On macOS, I usually use the osxkeychain for authentication using a "personal access token". This, for some reason didn't work out well and kept giving me the following error: fatal: could not read Username for 'https://github.com': Device not configured. I ensured that the script was being run as personal account, not root, but this didn't fix the issue. The easiest solution was to switch to using the git-credential-manager (GCM).

# check if current credential.helper is osxkeychain
❯ git config credential.helper
osxkeychain

# clear osxkeychain password
❯ git credential-osxkeychain erase
host=github.com
protocol=https
> [Press Return]

# install latest git and git credential manager (GCM) from homebrew
❯ brew install git
❯ brew tap microsoft/git
❯ brew install --cask git-credential-manager-core

# verify cask installation has automatically updated the credential.helper
❯ git config credential.helper
/usr/local/share/gcm-core/git-credential-manager-core

# attempt to git push, will bring up a pop-up establishing authentication
git push

For some reason, I was unable to change the hashbang for the post-commit hook. It seems to always use the system bash installed at /bin/bash (for me, version 3.2.57) even if I explicitly changed the hashbang to homebrew installed bash via #!/opt/homebrew/bin/bash. This means you can't use newer bash features like mycmd &>> /tmp/mylog etc.

This longer script helped me debug all of these issues:
```
#!/bin/bash
mkdir -p /tmp/logseq/
timestamp=$(date +"%s")
filepath="/tmp/logseq/$timestamp"
touch $filepath
echo "attepmting push" >> $filepath
echo "current directory: $(pwd)" >> $filepath
echo "bash version: $(bash --version)" >> $filepath
echo "whoami: $(whoami)" >> $filepath
git remote -v >> $filepath 2>&1
git push >> $filepath 2>&1
```

Hope this helps!

logseq / git-auto Goto Github PK

git-auto's Introduction

Logseq

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

Table of Contents

🤔 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

💎 Sponsors

🌟 Contributors

🫶 Backers

git-auto's People

Contributors

Stargazers

Watchers

Forkers

git-auto's Issues

Creating post-commit hook

Potential Gotchas

Recommend Projects

Recommend Topics

Recommend Org

Creating `post-commit` hook