A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap

clojure clojurescript git graph knowledge-base knowledge-graph local-first markdown note-taking org-mode pkm

Go to file

Tienson Qin 9b8c2caf02 fix: publishing not working at all		2021-01-14 14:26:21 +08:00
.github	fix(cd): fix single quote reference	2021-01-13 04:24:09 -08:00
public	chore: remove redundant ;	2020-12-06 21:28:23 +08:00
resources	style: improve block fold arrow and bullet interaction	2021-01-11 05:43:48 -08:00
src	fix: publishing not working at all	2021-01-14 14:26:21 +08:00
.gitignore	feat(dev): update build process	2020-11-02 10:52:37 +08:00
.projectile	Add contents	2020-07-21 15:50:13 +08:00
.stylelintrc.json	refactor: add stylelint processor	2020-12-07 12:37:20 +08:00
CODE_OF_CONDUCT.md	docs: add Code of Conduct	2020-11-09 14:41:54 +08:00
Dockerfile	add docker dev environment	2020-12-21 19:21:17 +08:00
LICENSE.md	fix(license): add exceptions for epl libraries	2020-11-03 23:46:52 +08:00
README.md	Emphasize the user's freedom and their control	2021-01-04 12:46:18 +08:00
deps.edn	chore: downgrade shadow-cljs	2021-01-10 21:03:30 +08:00
externs.js	fix: add missing externs	2021-01-12 21:13:45 +08:00
gulpfile.js	refactor: build styles	2020-12-21 14:02:02 +08:00
package.json	enhance: undo redo use patches instead of full text	2021-01-07 10:31:14 +08:00
postcss.config.js	fix: css styles	2020-12-18 18:46:30 +08:00
shadow-cljs.edn	chore: disable :fn-deprecated warning	2020-12-30 18:40:58 +08:00
tailwind.config.js	style: fix notification text theme issue & ui details	2020-12-13 12:43:36 +08:00
tailwind.css	feat(dev): better support for processing tailwind css	2020-11-02 09:56:52 +08:00
yarn.lock	enhance: undo redo use patches instead of full text	2021-01-07 10:31:14 +08:00

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.

Why Logseq?

Logseq is a freedom-respecting (and open-source too) 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.

Feature requests

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

How can I use it?

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.
Visit our website https://logseq.com/.
Click the "Login with GitHub" button in the upper-right corner.
Following the on-screen instructions, install Logseq app on your selected repository.
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:

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, disucss workflows and share tips
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.

Set up development environment

1. Requirements

Node.js & Yarn
Java & Clojure

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