Commit Graph

81 Commits

Author SHA1 Message Date
Tienson Qin
14e37941c0 Update README.md 2024-09-28 14:15:26 +08:00
Puneeth Chaganti
c51f7455a8 Fix typo in mldoc package name 2024-02-11 11:00:00 +08:00
djaggi
3971988c76 fix twitter badge README.md 2023-04-11 23:23:53 +08:00
Tienson Qin
f0a8ddf2a3 Update README.md 2023-04-03 17:39:09 +08:00
Tienson Qin
0989c1a6f8 Update links for backers and sponsors 2023-03-13 16:38:01 +08:00
Bad3r
773786bb75 Add Hub & Awesome-logseq to links 2023-03-06 12:14:32 +08:00
Gabriel Horner
b68ae17ab6 Shorten and move contributing sections from #8160
- Want the readme contributing section to be short to encourage
contributors to read CONTRIBUTING.md
- Emphasize non-coding ways to help as we could use help there
- Moved good first issues and dev links to CONTRIBUTING.md
2023-02-28 14:25:35 -05:00
Bad3r
849f70e891 docs: overhaul README structure (#8160)
* 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 <yongcong2001@outlook.com>
2023-02-28 14:21:10 -05:00
Gabriel Horner
80d63e079f Merge remaining readme contributing to CONTRIBUTING.md
Follow up to #8222
2023-02-14 14:00:06 -05:00
Junyi Du
304b33d6bb Chore: update dev section of README.MD 2023-01-12 00:14:20 +08:00
xxchan
42120121fa update link in README 2022-12-19 17:30:45 +08:00
Bad3r
a3ba2b2ffd fix(typo): minor changes in README.md
- Fixed a minor typo `you we'll` --> `you'll`
- Capitalized the `H` in `GitHub` to follow the official brand naming
2022-12-18 18:24:47 +08:00
SteOtt
367fc5c3a5 Update README.md
Updated link to blog. Formerly did point to https://logseq.com/blog with the last entry 2020.
2022-12-03 08:02:28 +08:00
WesleyCh3n
8f52021835 fix: readme typos (#7451) 2022-11-25 08:50:27 +08:00
Zhizhen He
4b5704c758 fix: change some punctuations from halfwidth to fullwidth for Chinese 2022-11-22 16:12:48 +08:00
glippi
f6ea0539f2 Add a section on how to contribute by opening a PR 2022-11-21 14:12:33 +08:00
Junyi Du
5335f758c0 chore: discord -> forum 2022-07-06 13:51:46 +08:00
Junyi Du
8c64e7ccda docs: Fix typo in README.md
Co-authored-by: Gabriel Horner <97210743+logseq-cldwalker@users.noreply.github.com>
2022-02-22 16:54:01 +08:00
Junyi Du
fa1a261004 doc: suggestions on win dev inst. from gabriel
Co-authored-by: Gabriel Horner <97210743+logseq-cldwalker@users.noreply.github.com>
2022-02-22 16:54:01 +08:00
Junyi Du
241132613a doc: add Windows develop instruction 2022-02-22 16:54:01 +08:00
Gabriel Horner
38d9cb7fbd Add dev practices doc to explain current state of linting 2022-01-12 17:00:11 -05:00
Gabriel Horner
3ded9ee1ff Add comment about allowed node version
node 17.x is the default for homebrew which doesn't work with this repo.
Make allowed node version more explicit to avoid dev confusion
2022-01-12 00:22:37 +08:00
Andelf
9acafb2745 build(docker): add docker build 2021-12-28 15:36:36 +08:00
Tienson Qin
1c7c57f3b5 doc: add instruction on install npm packages for building on desktop 2021-12-22 23:54:02 +08:00
Tienson Qin
02973cba6c Replace logseq.github.io with docs.logseq.com (#3526) 2021-12-20 12:32:44 +08:00
Bad3r
6a2fe9ab71 fixup! chore: Updated README E2E Testing Instructions 2021-11-30 11:03:36 +08:00
Bad3r
0d91953581 chore: Updated README E2E Testing Instructions
Updated the instructions for E2E testing

- Cypress was removed and replaced with playwright (https://github.com/logseq/logseq/pull/3241)
- Instructions are based on @andelf comment (https://github.com/logseq/logseq/pull/3241#issuecomment-976201958)
2021-11-30 11:03:36 +08:00
Gabriel Horner
d2675cdfe7 Remove clj testing as it's no longer used 2021-11-22 14:59:57 +08:00
Seth
9d999614bd update readme to include platform specific docker instructions 2021-10-25 11:39:41 +08:00
Tienson Qin
c113a4e43a chore: update FAQ 2021-08-09 20:55:00 +08:00
Tienson Qin
86f26065bc chore: update readme 2021-08-07 15:21:08 +08:00
Tienson Qin
e23503a5f2 chore: updated readme 2021-08-07 15:18:30 +08:00
Tienson Qin
ab8d0b45b5 chore: update readme 2021-08-01 21:47:20 +08:00
Tienson Qin
03d81a1c7a doc: add yarn e2e-test 2021-06-22 10:57:11 +08:00
Tienson Qin
c1e2b370f4 chore: update readme 2021-06-15 21:27:25 +08:00
Doug Holton
4ec098206c tiny missing step in instructions for compiling
added "cd logseq" line after git clone line, before running yarn
2021-06-13 08:32:35 +08:00
Tienson Qin
b000e7dcb4 Adjust order 2021-06-03 00:48:32 +08:00
Tienson Qin
fe265280cf Add product hunt badge 2021-06-03 00:47:43 +08:00
Tienson Qin
bcb7803397 Update README.md 2021-06-02 09:34:02 +08:00
Junyu Zhan
831d882aae doc: add link to codebase overview in readme 2021-06-01 21:49:56 +08:00
Tienson Qin
f635a71f54 fix: chinese discord group invitation link 2021-05-30 11:29:36 +08:00
James
49cdffec21 Link to free software's four freedoms to explain user control (#1722)
Co-authored-by: Tienson Qin <tiensonqin@gmail.com>
2021-05-20 00:07:42 +08:00
Tienson Qin
a0a423ceef Merge pull request #1191 from logseq/feat/outliner-core
Core outliner refactor
2021-05-20 00:05:13 +08:00
defclass
096a3a1c84 doc: add Chinese Discord url 2021-05-18 11:23:53 +08:00
Tienson Qin
e06efe3d45 chore: update text 2021-05-14 21:10:31 +08:00
Tienson Qin
ef5e14ddac Update README.md 2021-04-09 21:04:22 +08:00
Tienson Qin
4894379664 chore: Add Deta's logo 2021-04-09 21:00:42 +08:00
aurnik
c1cf6e3c62 Fix typo
`discuss` was spelled wrong, simple fix
2021-03-31 08:27:28 +08:00
Junyu Zhan
5c6b6b9615 doc: explain what the dockerfile does 2021-03-02 15:25:53 +08:00
Junyu Zhan
f10707967a doc: use shorthand command to run test 2021-03-02 15:25:53 +08:00