defclass
eb774cc9b1
doc(README): update readme for ENV
|
5 年之前 | |
|---|---|---|
| .github | 5 年之前 | |
| public | 5 年之前 | |
| resources | 5 年之前 | |
| src | 5 年之前 | |
| .gitignore | 5 年之前 | |
| .projectile | 5 年之前 | |
| .stylelintrc.json | 5 年之前 | |
| CODE_OF_CONDUCT.md | 5 年之前 | |
| Dockerfile | 5 年之前 | |
| LICENSE.md | 5 年之前 | |
| README.md | 5 年之前 | |
| deps.edn | 5 年之前 | |
| externs.js | 5 年之前 | |
| gulpfile.js | 5 年之前 | |
| package.json | 5 年之前 | |
| postcss.config.js | 5 年之前 | |
| shadow-cljs.edn | 5 年之前 | |
| tailwind.config.js | 5 年之前 | |
| tailwind.css | 5 年之前 | |
| yarn.lock | 5 年之前 |
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
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
ENV=prod yarn release
ENV: we can release a version for staging or prod. Logseq will read the environment variable from resources/config.edn
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