Skip to content
View StepOutliner's full-sized avatar

Block or report StepOutliner

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Please don't include any personal information such as legal names or email addresses. Maximum 100 characters, markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
StepOutliner/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.

Logseq - Your joyful, private digital garden | Product Hunt

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.

Image of logseq

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?

  1. Download the desktop app at https://github.com/logseq/logseq/releases.
  2. Start writing and have fun!

FAQ

Please go to https://logseq.github.io/#/page/faq.

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.

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

JetBrains

Popular repositories Loading

  1. StepOutliner StepOutliner Public

    Clojure 1

  2. rewardable-productivity rewardable-productivity Public

    Forked from logseq/logseq

    A privacy-first, open-source platform for knowledge management rewardable productivity steps. Download link: http://github.com/StepOutliner/rewardable-productivity/releases. roadmap:

    Clojure

  3. logseq-smartblocks logseq-smartblocks Public

    Forked from sawhney17/logseq-smartblocks

    TypeScript

  4. logseq-metrics logseq-metrics Public

    Forked from dangermccann/logseq-metrics

    JavaScript

  5. orbis-forum orbis-forum Public

    Forked from OrbisWeb3/forum-template

    A template to start building easily a community forum powered by Orbis.

    JavaScript

  6. orbis-chat-gpt orbis-chat-gpt Public

    Forked from OrbisWeb3/orbis-chat-gpt

    A decentralized version of Chat GPT built with Orbis.

    JavaScript