知识管理和协作平台

samfundev 389c4a9fd8 Fix filter icon not changing color 5 years ago
.github 5e0fbbd825 chore: remove yarn cache check for testing purpose 4 years ago
public 8caf2fe452 chore: remove redundant ; 4 years ago
resources bd5f497aca style: make compatible overflow wrap anywhere 4 years ago
src 389c4a9fd8 Fix filter icon not changing color 4 years ago
.gitignore df1043be0a feat(dev): update build process 5 years ago
.projectile d73e405b9e Add contents 5 years ago
.stylelintrc.json 7c7ce3d740 refactor: add stylelint processor 4 years ago
CODE_OF_CONDUCT.md a7616ca3d2 docs: add Code of Conduct 5 years ago
Dockerfile 5b4ca742a6 add docker dev environment 4 years ago
LICENSE.md a72ca41c95 fix(license): add exceptions for epl libraries 5 years ago
README.md 5b4ca742a6 add docker dev environment 4 years ago
deps.edn abf2544a8e chore: use borkdude/rewrite-edn (the cljc PR has been merged) 4 years ago
externs.js 10314b1117 fix: both pages and blocks indices default to an empty array 4 years ago
gulpfile.js b40b5925f7 refactor: build styles 4 years ago
package.json 2baa71baf8 fix(test): bump version of react and react-dom 4 years ago
postcss.config.js 6c1a1701bb fix: css styles 4 years ago
shadow-cljs.edn 2baa71baf8 fix(test): bump version of react and react-dom 4 years ago
tailwind.config.js 2db70bdfc4 style: fix notification text theme issue & ui details 4 years ago
tailwind.css 22887860df feat(dev): better support for processing tailwind css 5 years ago
yarn.lock 2baa71baf8 fix(test): bump version of react and react-dom 4 years ago

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 an open-source platform for knowledge sharing and management. 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.

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

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

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