Skip to content

Commit

Permalink
docs: overhaul README structure (logseq#8160)
Browse files Browse the repository at this point in the history
* enhancement(README): overhaul document structure

- Added logseq logo to the readme (I need a copy of the .svg logo) 
- Update the introduction format 
- Update the types of badges used
- change badges colors to fit Logseq colors 
- General readability improvements 
- emojis!

### Regarding open collective user images
As a backer; I appreciate the idea of wanting to display all profile pictures of logseq backers.
The number of backer now is +26k; it would be impossible to present them all.
I also think it turned into an eyesore, and it feels unwelcoming for new project viewers.

* fix: navigate to website when click on logo

* fix: Added backers to the bottom

based on community feedback

* fix: Thanks to section

- Separated sponsors from backers
- increased images sizes
- moved Jetbrains logo to the bottom

* fix: thanks to; section

* fix: move logo above header

* update: add contributors to 'thanks to' section

* fix: typo

* enhance(README.md): formatting

* enhance(README.md): logo position

* enhance(README.md): added links

* enhance: update logseq image

Thanks to @hdansou for providing the screenshot

* fix: change backers avatar size to be smaller

avoid timeout

* docs: update logseq description

* update: moved producthunt review button

* docs: add linebreaks

* cleanup 🧹

* Fix grammar issues 🧠

* update screenshot

* ✨🧼 revised and updated

* ✍ concise text

* 🔨 Fix typo

* 🎨 styling

* 🧽✨ clean up and improve consistancy

* 🔌 Update plugin API docs link & styling 🎨

* tool --> platform

* Merge FAQ and learn more sections

* Merge sponsors section

* center producthunt banner

* switch to circular logo ⭕🟦

* move learn more section higher

* add table of contents

* simplify how to section

* add whiteboard screenshot

* add link to 'develop togather' project board

* add new screenshots ✨

* update GTD screenshot to remove cursor

* add PDF annotation example screenshot

* update pdf demo screenshot

* replace PDF demo with video

* revert GIF

* remove video

* Replace images w/ gif

* update GIF

* shorten desc.

* adjust formatting

* adjust descrription to stay true to the original one written by Tienson

* update social logo colors

---------

Co-authored-by: situ2001 <[email protected]>
Bad3r and situ2001 authored Feb 28, 2023
1 parent d0c5261 commit 849f70e
Showing 1 changed file with 177 additions and 58 deletions.
235 changes: 177 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,96 +1,215 @@
# Logseq
<!-- logo -->
<p align="center">
<a href="https://logseq.com" alt="Logseq Logo">
<img src="https://user-images.githubusercontent.com/25513724/220608753-f33db466-af72-4611-b603-411440c15ed0.png?sanatize=true" height="173"/></a>
</p>

<h1 align="center"> Logseq </h1>

<h4 align="center">
A privacy-first, open-source platform for knowledge management and collaboration
</h4>

<div align="center">
<a href="https://logseq.com">Home Page</a> |
<a href="https://blog.logseq.com/">Blog</a> |
<a href="https://docs.logseq.com/">Documentation</a> |
<a href="https://trello.com/b/8txSM12G/roadmap">Roadmap</a>
</div>
<br></br>

<p align="center">
<a href="https://github.com/logseq/logseq/releases/latest/">
<img src="https://img.shields.io/badge/Download_Logseq-100000?style=for-the-badge&logo=flatpak&logoColor=white&labelColor=002b36&color=85c8c8"
alt="Download Logseq"/></a>
</p>

<!-- social badges -->
<p align="center">
<a href="https://discuss.logseq.com">
<img src="https://img.shields.io/badge/forum-Logseq-blue.svg?&color=%2385c8c8&logo=discourse&style=for-the-badge"
alt="forum"></a>
<a href="https://discord.gg/KpN4eHY">
<img src="https://img.shields.io/discord/725182569297215569?color=%2385c8c8&label=Discord&logo=discord&style=for-the-badge"
alt="chat on Discord"></a>
<a href="https://twitter.com/intent/follow?screen_name=logseq">
<img src="https://img.shields.io/twitter/follow/logseq?color=%2385c8c8&label=%40logseq&logo=twitter&style=for-the-badge"
alt="follow on Twitter"></a>
</p>

[![latest release version](https://img.shields.io/github/v/release/logseq/logseq)](https://github.com/logseq/logseq/releases)
[![License](https://img.shields.io/github/license/logseq/logseq?color=blue)](https://github.com/logseq/logseq/blob/master/LICENSE.md)
[![Twitter follow](https://img.shields.io/badge/follow-%40logseq-blue.svg?style=flat&logo=twitter)](https://twitter.com/logseq)
[![forum](https://img.shields.io/badge/forum-Logseq-blue.svg?style=flat&logo=discourse)](https://discuss.logseq.com)
[![discord](https://img.shields.io/discord/725182569297215569?label=discord&logo=Discord&color=blue)](https://discord.gg/KpN4eHY)
[![total](https://opencollective.com/logseq/tiers/badge.svg?color=blue)](https://opencollective.com/logseq)
<!-- dev badges -->
<p align="center">
<a href="https://github.com/logseq/logseq/graphs/contributors" alt="Contributors">
<img src="https://img.shields.io/github/contributors/logseq/logseq?color=%2385c8c8&style=for-the-badge"/></a>
<a href="#🫶-support-logseq-development" alt="Backers on Open Collective">
<img src="https://img.shields.io/opencollective/backers/logseq?color=%2385c8c8&style=for-the-badge"/></a>
<a href="#💎-sponsors" alt="Sponsors on Open Collective">
<img src="https://img.shields.io/opencollective/sponsors/logseq?color=%2385c8c8&style=for-the-badge"/></a>
<a href="https://github.com/logseq/logseq/blob/master/LICENSE.md" alt="Activity">
<img src="https://img.shields.io/github/license/logseq/logseq?color=%2385c8c8&style=for-the-badge"/></a>
<a href="https://github.com/logseq/logseq/releases">
<img src="https://img.shields.io/github/v/release/logseq/logseq?color=%2385c8c8&style=for-the-badge"
alt="latest release version"></a>
</p>

[![Contributors](https://opencollective.com/logseq/tiers/sponsors.svg?avatarHeight=24&width=600)](https://opencollective.com/logseq)
[![Contributors](https://opencollective.com/logseq/tiers/backers.svg?avatarHeight=24&width=600)](https://opencollective.com/logseq)
## Table of Contents

A local-first, non-linear, outliner notebook for organizing and sharing your personal knowledge base.
* [<g-emoji class="g-emoji" alias="thinking" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f914.png">🤔</g-emoji> Why Logseq?](#-why-logseq)
* [<g-emoji class="g-emoji" alias="eyes" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f440.png">👀</g-emoji> How can I use it?](#-how-can-i-use-it)
* [<g-emoji class="g-emoji" alias="books" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png">📚</g-emoji> Learn more](#-learn-more)
* [🫶 Support Logseq Development](#-support-logseq-development)
* [<g-emoji class="g-emoji" alias="bulb" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png">💡</g-emoji> Feature requests](#-feature-requests)
* [<g-emoji class="g-emoji" alias="electric_plug" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png">🔌</g-emoji> Plugin API](#-plugin-api)
* [<g-emoji class="g-emoji" alias="star2" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png">🌟</g-emoji> Contributing to Logseq](#-contributing-to-logseq)
* [<g-emoji class="g-emoji" alias="hammer_and_wrench" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png">🛠️</g-emoji> Setting Up a Development Environment](#️-setting-up-a-development-environment)
* [<g-emoji class="g-emoji" alias="mortar_board" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f393.png">🎓</g-emoji> Good First Issues](#-good-first-issues)
* [<g-emoji class="g-emoji" alias="sparkles" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/2728.png">✨</g-emoji> Inspiration](#-inspiration)
* [<g-emoji class="g-emoji" alias="pray" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png">🙏</g-emoji> Thank You](#-thank-you)

Use it to organize your todo list, to write your journals, or to record your unique life.
## 🤔 Why Logseq?

<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>
[Logseq](https://logseq.com) is a **knowledge management** and **collaboration** platform. It focuses on **privacy**, **longevity**, and [**user control**](https://www.gnu.org/philosophy/free-sw.en.html). Logseq offers a range of **powerful tools** for **knowledge management**, **collaboration**, **PDF annotation**, and **task management** with support for multiple file formats, including **Markdown** and **Org-mode**, and **various features** for organizing and structuring your notes.

## [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!
Logseq's **Whiteboard** feature lets you organize your knowledge and ideas using a spatial **canvas** with **shapes**, **drawings**, **website embeds**, and **connectors**. You can **visually group** and **link** your **notes** and external media (such as **videos** and **images**), enabling visual thinkers to compose, remix, **annotate**, and connect content from their knowledge base and emerging thoughts in a new way.

## Why Logseq?
In addition to its core features, Logseq has a growing ecosystem of **plugins** and **themes** that enable a wide range of workflows and **customization** options. **Mobile apps** are also available, providing access to most of the features of the desktop application. Whether you're a student, a professional, or anyone who values a clear and organized approach to managing your ideas and notes, Logseq is an excellent choice for anyone looking to improve their productivity and streamline their workflow.

[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).
![logseq-demo](https://user-images.githubusercontent.com/25513724/221387376-4dc419c2-0d0a-460c-a920-2d211e78b456.gif)

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).
<a href="https://github.com/logseq/logseq/releases/latest/">
<img src="https://img.shields.io/badge/Download_Logseq-100000?style=for-the-badge&logo=flatpak&logoColor=white&labelColor=002b36&color=85c8c8"
align="right"
alt="Download Logseq"/></a>

In the unlikely event that the website is down or cannot be maintained, your data is, and will always be yours.
## 👀 How can I use it?

![Image of logseq](https://cdn.logseq.com/%2F8b9a461d-437e-4ca5-a2da-18b51077b5142020_07_25_Screenshot%202020-07-25%2013-29-49%20%2B0800.png?Expires=4749255017&Signature=Qbx6jkgAytqm6nLxVXQQW1igfcf~umV1OcG6jXUt09TOVhgXyA2Z5jHJ3AGJASNcphs31pZf4CjFQ5mRCyVKw6N8wb8Nn-MxuTJl0iI8o-jLIAIs9q1v-2cusCvuFfXH7bq6ir8Lpf0KYAprzuZ00FENin3dn6RBW35ENQwUioEr5Ghl7YOCr8bKew3jPV~OyL67MttT3wJig1j3IC8lxDDT8Ov5IMG2GWcHERSy00F3mp3tJtzGE17-OUILdeuTFz6d-NDFAmzB8BebiurYz0Bxa4tkcdLUpD5ToFHU08jKzZExoEUY8tvaZ1-t7djmo3d~BAXDtlEhC2L1YC2aVQ__&Key-Pair-Id=APKAJE5CCD6X7MP6PTEA)
To start using Logseq, follow these simple steps:

## Sponsors
1. [Download](https://github.com/logseq/logseq/releases/latest) the latest version of Logseq
2. Install Logseq on your device and launch the application
3. Start writing ✍️

Our top sponsors are shown below! [[Become a sponsor](https://opencollective.com/logseq#sponsor)]
That's it! You can now enjoy the benefits of using Logseq to streamline your workflow, manage your projects, and stay on top of your goals. Have fun! 🎉

<a href="https://www.deta.sh/" target="_blank"><img width=200 height=100 src="https://uploads-ssl.webflow.com/5eb96efa78dc680fc15be3be/5ebd24f6cbf6e9ebd674656e_Logo.svg" /></a>
## 📚 Learn more

* Website: [logseq.com](https://logseq.com)
* Documentation: [docs.logseq.com](https://docs.logseq.com)
* FAQ page: [Logseq Docs: FAQ](https://docs.logseq.com/#/page/faq)
* Blog: [blog.logseq.com](https://blog.logseq.com)
* Please visit our [About page](https://blog.logseq.com/about) for the latest updates.
* Twitter: [@Logseq](https://twitter.com/logseq)
* Forum: [discuss.logseq.com](https://discuss.logseq.com) - Where we answer questions, discuss workflows, and share tips
* FAQ forum section: [Logseq Forum: FAQ](https://discuss.logseq.com/c/faq/6)
* Discord: [discord.gg/logseq](https://discord.gg/logseq)
* [中文 Discord](https://discord.gg/xYqcrXWymg)

## Plugins documentation (Draft)
The plugins documentation is at https://logseq.github.io/plugins. Any feedback would be greatly appreciated!
## 🫶 Support Logseq Development

## Feature requests
If you find Logseq useful and want to help us keep the project growing, please consider supporting our contributors on [Open Collective](https://opencollective.com/logseq). Your support shows our contributors that their efforts are appreciated and motivates them to continue their excellent work. Every contribution, no matter how small, helps us keep improving Logseq.

Please go to https://discuss.logseq.com/new-topic?category=feature-requests.
## 💡 Feature requests

## How can I use it?
We value your input on improving Logseq and making it more useful for you. If you have any ideas or feature requests, please share them in the [Logseq Forum: Feature
Requests](https://discuss.logseq.com/new-topic?category=feature-requests) section.

1. Download the desktop app at https://github.com/logseq/logseq/releases.
2. Start writing and have fun!
Your feedback helps us understand our users' needs and prioritize the features that matter most to you. We appreciate your time and effort in sharing your thoughts with us.

## FAQ
Please go to https://docs.logseq.com/#/page/faq.
We appreciate your support, and we look forward to hearing your ideas!

## Credits
## 🔌 Plugin API

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 provides a plugin API that enables developers to create custom plugins and extend the functionality of Logseq. The plugin API documentation is available at [plugins-doc.logseq.com](https://plugins-doc.logseq.com/), where you can find everything needed to get started with plugin development.

Logseq is also made possible by the following projects:
We value your feedback and suggestions on how to improve our documentation. Please do not hesitate to contact us with any comments or questions. Your input helps us to provide a better experience for our users and developers.

Thank you for using Logseq, and we look forward to seeing what you create with our plugin API!

## 🌟 Contributing to Logseq

- [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
To start contributing to Logseq, please follow the guidelines outlined in [CONTRIBUTING.md](CONTRIBUTING.md). We have a dedicated [overview page](CODEBASE_OVERVIEW.md) for Logseq's codebase and a [development practices guide](docs/dev-practices.md) that provides detailed information on our development process.

![Logseq Credits](https://asset.logseq.com/static/img/credits.png)
We welcome all contributions, big or small, and we appreciate your time and effort in helping us improve Logseq.

## Learn more
We look forward to your contributions 🚀

- Our blog: [https://blog.logseq.com/](https://blog.logseq.com) - Please be sure to visit our [About page](https://blog.logseq.com/about) for the latest updates of the app
- Twitter: https://twitter.com/logseq
- Forum: https://discuss.logseq.com - Where we answer questions, discuss workflows and share tips
- Discord: https://discord.gg/KpN4eHY
- 中文 Discord:https://discord.gg/xYqcrXWymg
- GitHub: https://github.com/logseq/logseq - everyone is encouraged to report issues!
### 🛠️ Setting Up a Development Environment

---
If you want to set up a development environment for the Logseq web or desktop app, please refer to the [Develop Logseq](docs/develop-logseq.md) guide for macOS/Linux users and the [Develop Logseq on Windows](docs/develop-logseq-on-windows.md) guide for Windows users.

The following is for developers and designers who want to build and run Logseq locally and contribute to this project.
In addition to these guides, you can also find other helpful resources in the [docs/](docs/) folder, such as the [Guide for Contributing to Translations](docs/contributing-to-translations.md), the [Docker Web App Guide](docs/docker-web-app-guide.md) and the [mobile development guide](docs/develop-logseq-on-mobile.md)

We have [a dedicated overview page](https://github.com/logseq/logseq/blob/master/CODEBASE_OVERVIEW.md) for Logseq's codebase overview and [a development practices page](docs/dev-practices.md).
### 🎓 Good First Issues

## Set up development environment
* For setting up web app / desktop app development environment on macOS / Linux, please refer to [Develop Logseq](docs/develop-logseq.md).
We have compiled a list of [good first issues](https://github.com/logseq/logseq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) to help you get started. These are issues that are beginner-friendly and do not require advanced knowledge of the codebase. We encourage new contributors to start with these issues and gradually work their way up to more challenging tasks.
We also have a project board to keep track of community contributions [Logseq - Develop Together 💪](https://github.com/orgs/logseq/projects/5?query=is%3Aopen+sort%3Aupdated-desc).

* For Windows users, please refer to [Develop Logseq on Windows](docs/develop-logseq-on-windows.md) in addition.
Thank you for considering contributing to Logseq!

There are more guides in [docs/](docs/), e.g. the [Guide for contributing to translations](docs/contributing-to-translations.md) and the [Docker web app guide](docs/docker-web-app-guide.md)
## ✨ Inspiration

## Contributing
Logseq is inspired by several unique tools and projects, including [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).

See [CONTRIBUTING.md](CONTRIBUTING.md)
We owe a huge debt of gratitude to the developers and creators of these projects, and we hope that Logseq can continue to build on their innovative ideas and make them accessible to a broader audience.

## Thanks
Thank you to all those who inspire us, and we look forward to seeing what the Logseq community will create with this tool!

Logseq is also made possible by the following projects:

[![JetBrains](docs/assets/jetbrains.svg)](https://www.jetbrains.com/?from=logseq)
* [Clojure & ClojureScript](https://clojure.org/) - A dynamic, functional, general-purpose programming language
* [DataScript](https://github.com/tonsky/datascript) - An 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 [maldoc](https://github.com/mldoc/mldoc)
* [isomorphic-git](https://isomorphic-git.org/) - A pure JavaScript implementation of Git for NodeJS and web browsers
* [SCI](https://github.com/borkdude/sci) - A Small Clojure Interpreter

# 🙏 Thank You

We want to express our sincere gratitude to our [Open Collective](https://opencollective.com/logseq) **sponsors**, **backers**, and **contributors**. Your support and contributions allow us to continue developing and improving Logseq. Thank you for being a part of our community and helping us make Logseq the best it can be!

## 💎 Sponsors

<p align="center">
<a href="https://opencollective.com/logseq#sponsor"> [Become a sponsor]</a>
</p>
<!-- Deta Logo -->
<p align="center">
<a href="https://www.deta.sh/" alt="Deta">
<img src="https://uploads-ssl.webflow.com/5eb96efa78dc680fc15be3be/5ebd24f6cbf6e9ebd674656e_Logo.svg"
style="width: 200px; height: 100px;"/></a>
</p>

<p align="center">
<a href="https://opencollective.com/logseq" alt="Sponsors on Open Collective">
<img src="https://opencollective.com/logseq/tiers/sponsors.svg?avatarHeight=42&width=600"/></a>
</p>

## 🌟 Contributors

<p align="center">
<a href="https://github.com/logseq/logseq/graphs/contributors">
<img src="https://contrib.rocks/image?repo=logseq/logseq&max=300&columns=14" width="600"/></a>
</p>

## 🫶 Backers

<p align="center">
<a href="https://opencollective.com/logseq" alt="Backers on Open Collective">
<img src="https://opencollective.com/logseq/tiers/backers.svg?avatarHeight=24&width=600"/></a>
</p>

<!-- JetBrains Logo -->
<p align="center">
<a href="https://jetbrains.com" alt="JetBrains">
<img src="docs/assets/jetbrains.svg"/></a>
</p>

<!-- ProductHunt Review Button -->
<p align="center">
<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=dark"
align="center"
alt="Logseq - Your joyful, private digital garden | Product Hunt" style="width: 250px; height: 54px;"
width="250" height="54"/></a>
</p>

0 comments on commit 849f70e

Please sign in to comment.