e23503a5f2
|
||
|---|---|---|
| .clj-kondo | ||
| .github | ||
| cypress | ||
| docs | ||
| libs | ||
| public | ||
| resources | ||
| scripts | ||
| src | ||
| templates | ||
| .gitignore | ||
| .prettierrc.js | ||
| .projectile | ||
| .stylelintrc.json | ||
| CODEBASE_OVERVIEW.md | ||
| CODE_OF_CONDUCT.md | ||
| Dockerfile | ||
| LICENSE.md | ||
| README.md | ||
| cypress.json | ||
| deps.edn | ||
| externs.js | ||
| gulpfile.js | ||
| package.json | ||
| postcss.config.js | ||
| shadow-cljs.edn | ||
| tailwind.all.css | ||
| tailwind.config.js | ||
| yarn.lock | ||
README.md
Logseq
A local-first, non-linear, outliner notebook for organizing and sharing your personal knowledge base.
Use it to organize your todo list, to write your journals, or to record your unique life.
Download our free Desktop app
Sponsor our contributors on Open Collective, Logseq will move to Stripe later!
Why Logseq?
Logseq is a platform for knowledge management and collaboration. It focuses on privacy, longevity, and user control.
The server will never store or analyze your private notes. Your data are plain text files and we currently support both Markdown and Emacs Org mode (more to be added soon).
In the unlikely event that the website is down or cannot be maintained, your data is, and will always be yours.
Sponsors
Our top sponsors are shown below! [Become a sponsor]
Plugins documentation (Draft)
The plugins documentation is at https://logseq.github.io/plugins. Any feedback would be greatly appreciated!
Feature requests
Please go to https://discuss.logseq.com/c/feature-requests/7.
How can I use it?
- Download the desktop app at https://github.com/logseq/logseq/releases.
- Start writing and have fun!
FAQ
1. Do you plan to charge for the logseq app (desktop/web/mobile)?
All the existing local-only features (including the latest SRS cards, pdf annoations, zotero integration) will be free to use, we'll announce a monthly subscription for syncing with our own storage, real-time collaboration, and other pro features in the future.
2. Do you commit to open source the frontend code (including the desktop/web/mobile apps) forever?
Yes. You can build the apps with the latest code and it'll work with your local files (markdown/org). The mobile app might start with a simple API but eventually, it'll have local files support.
3. Are you going to open-source the future server-side backend?
No, we have no plan for that. But we're considering providing a free self-host sync option for non-profit organizations or researchers in the future, the sync service for our own storage is not started yet.
Credits
Logseq is hugely inspired by Roam Research, Org Mode, Tiddlywiki, Workflowy and Cuekeeper, hats off to all of them!
Logseq is also made possible by the following projects:
- Clojure & ClojureScript - A dynamic, functional, general-purpose programming language
- DataScript - Immutable database and Datalog query-engine for Clojure, ClojureScript and JS
- OCaml & Angstrom, for the document parser
- isomorphic-git - A pure JavaScript implementation of Git for node and browsers
- sci - Small Clojure Interpreter
Learn more
- Our blog: https://logseq.com/blog - Please be sure to visit our About page for the latest updates of the app
- Twitter: https://twitter.com/logseq
- Discord: https://discord.gg/KpN4eHY - Where we answer questions, discuss workflows and share tips
- 中文 Discord：https://discord.gg/xYqcrXWymg
- Github: https://github.com/logseq/logseq - everyone is encouraged to report issues!
The following is for developers and designers who want to build and run Logseq locally and contribute to this project.
We also have a dedicated page for LogSeq's codebase overview.
Set up development environment
1. Requirements
- Node.js & Yarn
- Java & Clojure. (If you run into
Execution error (FileNotFoundException) at java.io.FileInputStream/open0 (FileInputStream.java:-2). -M:cljs (No such file or directory), it means you have a wrong Clojure version installed. Please uninstall it and follow the instructions linked.)
2. Compile to JavaScript
git clone https://github.com/logseq/logseq
cd logseq
yarn
yarn watch
3. Open the browser
Open http://localhost:3001.
4. Build a release
yarn release
5. Run tests
Run ClojureScript tests
yarn test
Run Cypress tests
yarn e2e-test
Run Clojure tests. (Note: .cljc files may be tested both by ClojureScript, and Clojure.)
clj -Mtest-clj
Desktop app development
1. Compile to JavaScript
yarn watch
2. Open the dev app
yarn dev-electron-app
3. Build a release
yarn release-electron
Alternative: Docker based development environment
Basically it just pre-installs Java, Clojure and NodeJS for your convenience.
1. Fetch sources
git clone https://github.com/logseq/logseq
2. Build Docker image
cd logseq
docker build -t logseq-docker .
3. Run Docker container
docker run -v $(pwd):/home/logseq/logseq -p 3001:3001 -p 9630:9630 -p 8701:8701 --rm -it logseq-docker /bin/bash
4. Inside the container compile as described above
cd logseq
yarn
yarn watch
Thanks
