知识管理和协作平台

charlie 9cb8bdd2cb improve(electron): adapt some remote resources to local %!s(int64=4) %!d(string=hai) anos
.github 61af1627e4 fix(cd): fix single quote reference %!s(int64=4) %!d(string=hai) anos
docs 09d48718a8 chore(readme): add thanks section %!s(int64=4) %!d(string=hai) anos
public da8b92c0b3 fix: remove mldoc.min.js %!s(int64=4) %!d(string=hai) anos
resources 9cb8bdd2cb improve(electron): adapt some remote resources to local %!s(int64=4) %!d(string=hai) anos
src 9cb8bdd2cb improve(electron): adapt some remote resources to local %!s(int64=4) %!d(string=hai) anos
.gitignore 538a3dd5c1 feat: electron wip %!s(int64=4) %!d(string=hai) anos
.projectile d73e405b9e Add contents %!s(int64=5) %!d(string=hai) anos
.stylelintrc.json 7c7ce3d740 refactor: add stylelint processor %!s(int64=4) %!d(string=hai) anos
CODE_OF_CONDUCT.md a7616ca3d2 docs: add Code of Conduct %!s(int64=5) %!d(string=hai) anos
Dockerfile 5b4ca742a6 add docker dev environment %!s(int64=4) %!d(string=hai) anos
LICENSE.md a72ca41c95 fix(license): add exceptions for epl libraries %!s(int64=5) %!d(string=hai) anos
README.md a9df8deaae final touches on dual platform testing of Raom import %!s(int64=4) %!d(string=hai) anos
deps.edn ea66b25a5a Merge branch 'master' into feat/electron %!s(int64=4) %!d(string=hai) anos
externs.js e7809900a7 refactor: simplify handlers %!s(int64=4) %!d(string=hai) anos
gulpfile.js 16a5974656 improve(electron): development experience %!s(int64=4) %!d(string=hai) anos
package.json 8500afb849 improve(electron): use fragment mode for frontend router & polish UI %!s(int64=4) %!d(string=hai) anos
postcss.config.js 6c1a1701bb fix: css styles %!s(int64=4) %!d(string=hai) anos
shadow-cljs.edn ca973f6560 chore: add devtools for electron %!s(int64=4) %!d(string=hai) anos
tailwind.config.js 2db70bdfc4 style: fix notification text theme issue & ui details %!s(int64=4) %!d(string=hai) anos
tailwind.css 22887860df feat(dev): better support for processing tailwind css %!s(int64=5) %!d(string=hai) anos
yarn.lock 26be1ff969 electron: file watcher wip %!s(int64=4) %!d(string=hai) anos

README.md

Logseq

latest release version License Twitter follow discord total

Contributors Contributors

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.

Why Logseq?

Logseq is a platform for knowledge sharing and management. It focuses on privacy, longevity, and user control. Notice: the backend code will not be open-sourced for security reasons and other potential risks.

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.

Image of logseq

Feature requests

Please go to https://discuss.logseq.com/c/feature-requests/7.

How can I use it?

  1. Make sure you have registered a GitHub account and already created a repository (could be an old one). Currently we only support GitHub, but more sync options (e.g. Gitlab, Dropbox, Google Drive, WebDAV, etc.) will be added soon.

  2. Visit our website https://logseq.com/.

  3. Click the "Login with GitHub" button in the upper-right corner.

  4. Following the on-screen instructions, install Logseq app on your selected repository.

  5. Start writing and have fun!

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:

Logseq Credits

Learn more


The following is for developers and designers who want to build and run Logseq locally and contribute to this project.

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
yarn
yarn watch

3. Open the browser

Open http://localhost:3001.

4. Build a release

yarn release

5. Run tests

Run ClojureScript tests

yarn
yarn cljs:test
node static/tests.js

Run Clojure tests. (Note: .cljc files may be tested both by ClojureScript, and Clojure.)

clj -Mtest-clj

Alternative: Docker based development environment

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

JetBrains