greatbody
/
logseq
mirror of https://github.com/logseq/logseq
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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
5,020 Commits
92 Branches
187 Tags
239 MiB
Clojure 59.4%
TypeScript 20.3%
CSS 13.5%
JavaScript 4.7%
HTML 0.9%
Other 1.1%
 
 
 
 
 
 
Go to file
tiagodevezas 9e82f0117c Translate shortcuts to Portuguese (pt-PT) 2021-09-06 08:49:34 +08:00
.clj-kondo feat: add a kondo map for auto-transact! 2021-04-26 19:10:19 +08:00
.github enhance: github release action 2021-08-20 11:54:22 +08:00
cypress feat(test): add template-basic e2e-test 2021-06-23 10:15:32 +08:00
docs chore: rename LogSeq to Logseq 2021-03-13 20:28:53 +08:00
libs chore(plugin): bump libs version 2021-08-25 16:28:57 +08:00
public Use web workers to speed up parsing (#2655) 2021-08-18 17:02:40 +08:00
resources chore(deps): bump tar from 4.4.17 to 4.4.19 in /resources 2021-09-01 10:52:14 +08:00
scripts chore: add publishing.sh 2021-03-01 21:08:01 +08:00
src Translate shortcuts to Portuguese (pt-PT) 2021-09-06 08:49:34 +08:00
templates enhance: display a warning button for the demo graph 2021-08-26 00:17:49 +08:00
.gitignore test: cypress scaffolding 2021-06-22 10:57:11 +08:00
.prettierrc.js chore: add a prettier config 2021-03-16 23:03:46 +08:00
.projectile add mhchem plugin 2021-07-25 18:47:43 +08:00
.stylelintrc.json refactor: add stylelint processor 2020-12-07 12:37:20 +08:00
CODEBASE_OVERVIEW.md fix: switch to lowercase file extension 2021-06-02 12:41:27 +08:00
CODE_OF_CONDUCT.md docs: add Code of Conduct 2020-11-09 14:41:54 +08:00
Dockerfile fix clojure version in Docker container 2021-03-11 15:08:29 +08:00
LICENSE.md fix(license): add exceptions for epl libraries 2020-11-03 23:46:52 +08:00
README.md chore: update FAQ 2021-08-09 20:55:00 +08:00
cypress.json test: add some tests 2021-06-22 10:57:11 +08:00
deps.edn Use web workers to speed up parsing (#2655) 2021-08-18 17:02:40 +08:00
externs.js feat: git integration 2021-08-24 21:42:46 +08:00
gulpfile.js fix: add rebuild:better-sqlite3 to electron release 2021-06-15 22:13:08 +08:00
package.json enhance: hide logbook by default 2021-08-31 12:48:51 +08:00
postcss.config.js chore: upgrade tailwind 2021-07-06 23:47:13 +08:00
shadow-cljs.edn fix(dev): import cljs runtime scripts for parser worker base on file:// 2021-08-19 17:16:51 +08:00
tailwind.all.css style(pdf): import viewer css correctly 2021-07-16 15:52:54 +08:00
tailwind.config.js chore: fix indent 2021-07-22 12:07:04 +08:00
yarn.lock enhance: hide logbook by default 2021-08-31 12:48:51 +08:00

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

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.

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