mirror of https://github.com/logseq/logseq
182 lines
6.7 KiB
Markdown
182 lines
6.7 KiB
Markdown
# Logseq
|
||
|
||
[](https://github.com/logseq/logseq/releases)
|
||
[](https://github.com/logseq/logseq/blob/master/LICENSE.md)
|
||
[](https://twitter.com/logseq)
|
||
[](https://discord.gg/KpN4eHY)
|
||
[](https://opencollective.com/logseq)
|
||
|
||
[](https://opencollective.com/logseq)
|
||
[](https://opencollective.com/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.
|
||
|
||
<a href="https://www.producthunt.com/posts/logseq?utm_source=badge-review&utm_medium=badge&utm_souce=badge-logseq#discussion-body" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/review.svg?post_id=298158&theme=light" alt="Logseq - Your joyful, private digital garden | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||
|
||
## [Download our free Desktop app](https://github.com/logseq/logseq/releases)
|
||
[Sponsor our contributors on Open Collective](https://opencollective.com/logseq), Logseq will move to Stripe later!
|
||
|
||
## Why Logseq?
|
||
|
||
[Logseq](https://logseq.com) is a platform for knowledge management and collaboration. It focuses on privacy, longevity, and [user control](https://www.gnu.org/philosophy/free-sw.en.html).
|
||
|
||
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.
|
||
|
||
|
||
|
||
## Sponsors
|
||
|
||
Our top sponsors are shown below! [[Become a sponsor](https://opencollective.com/logseq#sponsor)]
|
||
|
||
<a href="https://www.deta.sh/" target="_blank"><img width=200 height=100 src="https://uploads-ssl.webflow.com/5eb96efa78dc680fc15be3be/5ebd24f6cbf6e9ebd674656e_Logo.svg" /></a>
|
||
|
||
|
||
## 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](https://roamresearch.com/), [Org Mode](https://orgmode.org/), [Tiddlywiki](https://tiddlywiki.com/), [Workflowy](https://workflowy.com/) and [Cuekeeper](https://github.com/talex5/cuekeeper), hats off to all of them!
|
||
|
||
Logseq is also made possible by the following projects:
|
||
|
||
- [Clojure & ClojureScript](https://clojure.org/) - A dynamic, functional, general-purpose programming language
|
||
- [DataScript](https://github.com/tonsky/datascript) - Immutable database and Datalog query-engine for Clojure, ClojureScript and JS
|
||
- [OCaml](https://ocaml.org/) & [Angstrom](https://github.com/inhabitedtype/angstrom), for the document [parser](https://github.com/mldoc/mldoc)
|
||
- [isomorphic-git](https://isomorphic-git.org/) - A pure JavaScript implementation of Git for node and browsers
|
||
- [sci](https://github.com/borkdude/sci) - Small Clojure Interpreter
|
||
|
||
|
||
|
||
## Learn more
|
||
|
||
- Our blog: https://logseq.com/blog - Please be sure to visit our [About page](https://logseq.com/blog/about) for the latest updates of the app
|
||
- Twitter: https://twitter.com/logseq
|
||
- Discord: https://discord.gg/KpN4eHY - Where we answer questions, discuss workflows and share tips
|
||
- 中文 Discord：https://discord.gg/xYqcrXWymg
|
||
- 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.
|
||
|
||
We also have [a dedicated page](https://github.com/logseq/logseq/blob/master/CODEBASE_OVERVIEW.md) for LogSeq's codebase overview.
|
||
|
||
## Set up development environment
|
||
|
||
### 1. Requirements
|
||
|
||
- [Node.js](https://nodejs.org/en/download/) & [Yarn](https://classic.yarnpkg.com/en/docs/install/)
|
||
- [Java & Clojure](https://clojure.org/guides/getting_started). (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
|
||
|
||
```bash
|
||
git clone https://github.com/logseq/logseq
|
||
cd logseq
|
||
yarn
|
||
yarn watch
|
||
```
|
||
|
||
### 3. Open the browser
|
||
|
||
Open <http://localhost:3001>.
|
||
|
||
### 4. Build a release
|
||
|
||
```bash
|
||
yarn release
|
||
```
|
||
|
||
### 5. Run tests
|
||
|
||
Run ClojureScript tests
|
||
|
||
```bash
|
||
yarn test
|
||
```
|
||
|
||
Run Cypress tests
|
||
|
||
``` bash
|
||
yarn e2e-test
|
||
```
|
||
|
||
## Desktop app development
|
||
|
||
### 1. Compile to JavaScript
|
||
|
||
```bash
|
||
yarn watch
|
||
```
|
||
|
||
### 2. Open the dev app
|
||
|
||
```bash
|
||
yarn dev-electron-app
|
||
```
|
||
|
||
### 3. Build a release
|
||
|
||
```bash
|
||
yarn release-electron
|
||
```
|
||
|
||
## Alternative: Docker based development environment
|
||
|
||
Basically it just pre-installs Java, Clojure and NodeJS for your convenience.
|
||
|
||
### 1. Fetch sources
|
||
|
||
```bash
|
||
git clone https://github.com/logseq/logseq
|
||
```
|
||
|
||
### 2. Build Docker image
|
||
|
||
```bash
|
||
cd logseq
|
||
docker build -t logseq-docker .
|
||
```
|
||
|
||
### 3. Run Docker container
|
||
|
||
#### MacOS/Linux
|
||
|
||
```bash
|
||
docker run -v $(pwd):/home/logseq/logseq -p 3001:3001 -p 9630:9630 -p 8701:8701 --rm -it logseq-docker /bin/bash
|
||
```
|
||
#### Windows
|
||
|
||
```bash
|
||
docker run -v %cd%:/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
|
||
|
||
```bash
|
||
cd logseq
|
||
yarn
|
||
yarn watch
|
||
```
|
||
|
||
## Thanks
|
||
|
||
[](https://www.jetbrains.com/?from=logseq)
|