Official reference documentation for Logseq.
See CONTRIBUTING.md.
Logseq documentation
Home Page: https://docs.logseq.com
License: MIT License
Official reference documentation for Logseq.
See CONTRIBUTING.md.
Document the missing Logseq properties.
Legend
(1) and (N) indicate how many values you may define, one and multiple values, respectively.
(page) and (block) indicates whether a property is a page or a block-only property. Otherwise, a property can be both a page and a block property.
Source: property.cljs
Property | Description | |
---|---|---|
collapsed |
specifies whether a block is collapsed. | (1) (block) |
id |
specifies a block ID. | (1) (block) |
created-at |
deprecated property that defines the created date/time stamps in Unix time. | (1) (block) |
updated-at |
deprecated property that defines the updated date/time stamps in Unix time. previously last-modified-at |
(1) (block) |
query-table |
marks a query to be shown as the table view. | (1) (block) |
query-properties |
properties user has chosen to see in query table. | (N) (block) |
query-sort-by |
property by which to sort query table. | (1) (block) |
query-sort-desc |
property sort direction. boolean where true is descending | (1) (block) |
custom-id |
(1) (block) | |
background-color |
(1) (block) | |
ls-type |
||
hl-page |
||
hl-stamp |
||
hl-color |
||
logseq.macro-name |
(1) | |
logseq.macro-arguments |
(n) | |
logseq.tldraw.page |
||
logseq.tldraw.shape |
I tried the advanced query below src here and it didn't return any results, despite having pages that have #programming
tags.
#+BEGIN_QUERY
{:title "All pages have a *programming* tag"
:query [:find ?name
:in $ ?tag
:where
[?t :block/name ?tag]
[?p :block/tags ?t]
[?p :block/name ?name]]
:inputs ["programming"]
:view (fn [result]
[:div.flex.flex-col
(for [page result]
[:a {:href (str "#/page/" page)} (clojure.string/capitalize page)])])}
#+END_QUERY
I suspect the example is wrong, particularly the :block/tags
part, for two reasons:
:block/tags
attribute.block/tags
attribute, nothing is returned.#+BEGIN_QUERY
{:title "All tasks"
:query [:find (pull ?b [*])
:where
[?b :block/tags _]]}
#+END_QUERY
Could this example be wrong? If so, how would one do this query?
Document for namespace is missing on https://github.com/logseq/docs
Supporting material:
logseq/logseq#3214 (comment)
Should this repo be under CC or MIT?
https://creativecommons.org/licenses/
https://choosealicense.com/licenses/
Add license:
https://github.com/logseq/docs/community/license/new?branch=master&filename=LICENSE
Will be removed after Logseq publishing supports assets
I was trying to understand what's the actual meaning of between
, but I can't find the documentation. It seems to be the task's journal date, but these queries made me think it's the referenced journal date: (Tasks referencing due dates ...)
docs/pages/Advanced Queries.md
Lines 177 to 204 in cdbec0f
Then I found the definition here https://github.com/logseq/logseq/blob/master/deps/db/src/logseq/db/rules.cljc
:between
'[(between ?b ?start ?end)
[?b :block/page ?p]
[?p :block/journal? true]
[?p :block/journal-day ?d]
[(>= ?d ?start)]
[(<= ?d ?end)]]
So it's indeed the task's journal date and the queries above are wrongly explained. I think it might be better to add documentation for these rules, and fixup the examples.
Logseq Docs | config.edn Template |
![]() | ![]() |
I think the config.edn template should be updated to match the example in Logseq docs.
The codeblock formatting in Docs is strange to me. It can be improved by splitting the first line to make it fit within the codeblock without needing to scroll to the right.
Also, the number of spaces used for indentation seems unnecessarily long. @logseq-cldwalker, what do you think? I can submit a PR to fix both.
Most docs-related issues will still be moved to the docs' repo. This issue is technically 2 issues.
1. Update codeblock formatting in Logseq docs.
2. update config.edn template to match Logseq docs.
"Make a Card" should read "Make a Flashcard" upon right click.
Make a card - Docs
It's a painful process of tracking down performance issues. For example:
https://twitter.com/cnjunyi/status/1607056174612119553?s=20&t=-Jcq3KLOuB8UU7M_1wPpvQ
logseq/logseq#8137
We should setup a FAQ on the forum https://discuss.logseq.com/c/faq/6 to help saving the communication cost of the process. Then make it to the document.
Some basic text pieces on the topic:
Most performance degradation happens when edited from outside, may caused by cache corruption. Try best to collect the way to reproduce the performance degradation.
To reset the cache issue, may try in following steps: Re-index. Clear cache.
A performance profile will be super helpful https://help.figma.com/hc/en-us/articles/360041468414-Record-a-Chrome-Performance-Profile
Locating the content that cause the performance issue will be very helpful
Thanks for the amazing docs. I find that using this feature is not always easy and straight-forward, and it may make a mess for users and confuse them. should describe the detailed behavior of the page alias so that users can be comfortable using the page alias feature.
https://docs.logseq.com/#/page/term%2Falias
For example.
Logseq offers "Contents":
If I do Ctrl+F in https://docs.logseq.com/#/page/contents, I don't find a help on "Contents".
First, I thought, this would be auto-generated, because I was thinking of it as short form of "table of contents" or a variant of "outline". However, I can type into. What am I supposed to type into?
It would be OK to add a dummy page linking to https://discuss.logseq.com/t/what-is-the-contents-md-page/8869.
In call cases, the help page should be linked from the contents panel.
Following comment by alex0 should also be explained:
I use Contents.md as table of contents like in other applications.
Does one need to generate a Contents.md
manually?
Maybe I should stress https://discuss.logseq.com/t/rename-contents-to-pinboard/8895:
Rename Contents to Pinboard
Its been mentioned a couple of times that option Prefer pasting file
are confusing and could benefit from being documented. This issue is created for tracking porpuses.
A main blame of query issue is actually about clause order of queries.
We should setup a FAQ on the forum https://discuss.logseq.com/c/faq/6 to help saving the communication cost of the process. Then make it to the document.
References:
https://docs.logseq.com/#/page/advanced%20queries
https://docs.datomic.com/on-prem/query/query-executing.html#clause-order
https://github.com/logseq/logseq/blob/d0af76d513407f660946d9c957cf2786f430e2a2/deps/db/src/logseq/db/rules.cljc#L26-L62
The clauses are executed sequentially.
If you mention a binding in a clause that is not mentioned at all in the previous section,
it will do a full-text search, which will be very slow
So you should try to use up the input in the first order, and keep the conditions small
To narrow the scope step by step
For example, if the input is ?cn:
[?b :block/page ?p] ;; This clause has no constraints, so don't put it here
[?cd :block/name ?cn]
[?b :block/path-refs ?cd]
(not [?b :block/page ?cd])
should be changed to
[?cd :block/name ?cn]
[?b :block/path-refs ?cd]
(not [?b :block/page ?cd])
[?b :block/page ?p] ;; wait for the previous clause to narrow down, then execute the unqualified clause
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.