|
|
@@ -25,11 +25,12 @@ In the unlikely event that the website is down or cannot be maintained, your dat
|
|
|

|
|
|
|
|
|
## 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](https://github.com/join) 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._
|
|
|
+1. Make sure you have registered a [GitHub account](https://github.com/join) 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/>.
|
|
|
|
|
|
@@ -60,7 +61,7 @@ Logseq is also made possible by the following projects:
|
|
|
- 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.
|
|
|
|
|
|
@@ -73,7 +74,7 @@ The following is for developers and designers who want to build and run Logseq l
|
|
|
|
|
|
### 2. Compile to JavaScript
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
git clone https://github.com/logseq/logseq
|
|
|
yarn
|
|
|
yarn watch
|
|
|
@@ -85,13 +86,14 @@ Open <http://localhost:3001>.
|
|
|
|
|
|
### 4. Build a release
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
yarn release
|
|
|
```
|
|
|
|
|
|
### 5. Run tests
|
|
|
|
|
|
Run ClojureScript tests
|
|
|
+
|
|
|
```bash
|
|
|
yarn
|
|
|
yarn cljs:test
|
|
|
@@ -99,6 +101,7 @@ node static/tests.js
|
|
|
```
|
|
|
|
|
|
Run Clojure tests. (Note: `.cljc` files may be tested both by ClojureScript, and Clojure.)
|
|
|
+
|
|
|
```bash
|
|
|
clj -Mtest-clj
|
|
|
```
|
|
|
@@ -107,19 +110,19 @@ clj -Mtest-clj
|
|
|
|
|
|
### 1. Compile to JavaScript
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
yarn watch
|
|
|
```
|
|
|
|
|
|
### 2. Open the dev app
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
yarn dev-electron-app
|
|
|
```
|
|
|
|
|
|
### 3. Build a release
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
yarn release-electron
|
|
|
```
|
|
|
|
|
|
@@ -127,26 +130,26 @@ yarn release-electron
|
|
|
|
|
|
### 1. Fetch sources
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
git clone https://github.com/logseq/logseq
|
|
|
```
|
|
|
|
|
|
### 2. Build Docker image
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
cd logseq
|
|
|
docker build -t logseq-docker .
|
|
|
```
|
|
|
|
|
|
### 3. Run Docker container
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
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
|
|
|
|
|
|
-``` bash
|
|
|
+```bash
|
|
|
cd logseq
|
|
|
yarn
|
|
|
yarn watch
|