logseq-go

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #llm #golang #rust #deep-learning #docker #awesome #cli #kubernetes #vue

(★ 10)

Read, manipulate and save Logseq notes using Go

logseq-go 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# logseq-go

logseq-go is a Go library to work with a [Logseq](https://logseq.com) graph,
with support for reading and modifying journals and pages.

⚠️ **Note:** This library is still in early development, it may destroy your data
when pages are modified. Please open issues if you find any bugs.

## Features

- Read and write journals and pages
- Rename and delete pages, with references to a renamed page updated across the
  graph
- Search, linked references and lookup of blocks by their id
- Aliases and namespaces, such as `Parent/Child`
- Rich content model
  - Blocks
  - Formatting via headings, paragraphs, lists, code blocks, etc.
  - Highlights via `^^Example^^`
  - Tables in the GitHub Flavored Markdown syntax
  - LaTeX via `$formula$` and math blocks
  - Footnotes via `[^1]` and `[^1]: The footnote`
  - Page links via `[[Example]]`
  - Tags via `#Example` and `#[[Example with space]]`
  - Macros via `{{macro param1 param2}}`
  - Block references via `((block-id))`

## Usage

Open a graph to access its content:

```go
graph, err := logseq.Open(ctx, "path/to/graph")
```

Content can be opened read only:

```go
journalPage, err := graph.OpenJournal(time.Now())
page, err := graph.OpenPage("Example")

for _, block := range page.Blocks() {
  // ...
}
```

In a graph with indexing enabled, opening a page by one of the aliases in its
`alias::` property opens the page the alias belongs to, instead of creating a
second page for the same content.

The properties that hold a list of pages, such as `alias::` and `tags::`, have
their values read as references to those pages, so `tags:: Book, Reading`
points at two pages without either being written as a link. The graph decides
which other properties are read that way via `:property/separated-by-commas`,
and which properties never point at a page via
`:ignored-page-references-keywords`.

The blocks that reference a page, what Logseq shows as its linked references,
are available from the page itself:

```go
references, err := page.LinkedReferences(ctx)

for _, reference := range references.Results() {
  block, referencingPage, err := reference.Open()
  // ...
}
```

Pages with a `/` in their title are part of a namespace, and the pages in a
namespace can be found from the page it belongs to:

```go
page, err := graph.OpenPage("Parent/Child")

page.Namespace() // Parent

children, err := page.NamespaceChildren(ctx)
```

Blocks that have an id, which is what block references such as `((id))` point
at, can be opened directly in a graph that has indexing enabled:

```go
block, page, err := graph.OpenBlock(ctx, "65a1b2c3-d4e5-6789-abcd-ef0123456789")
```

Content can also be opened for writing, by creating a transaction:

```go
tx := graph.NewTransaction()

today, err := tx.OpenJournal(time.Now())

today.AddBlock(content.NewBlock(
  content.NewText("Hello!")
))

// Save all the changes made
err = tx.Save()
```

Pages can be renamed and deleted in a transaction as well. Renaming points all
the references to the page, such as `[[Old]]` and `#Old`, at the new title,
which requires the graph to be opened with indexing enabled:

```go
tx := graph.NewTransaction()

err = tx.RenamePage(ctx, "Old", "New")
err = tx.DeletePage("Unwanted")

err = tx.Save()
```

Pages in the namespace of a renamed page keep their titles, unless the rename
asks for them to come along:

```go
// Renames Old, Old/Child and Old/Child/Grandchild
err = tx.RenamePage(ctx, "Old", "New", logseq.WithNamespaceChildren())
```

Deleted pages are removed from the graph, unless the graph is opened with
`logseq.WithRecycleDeletedPages()`, in which case they are moved to the
`logseq/.recycle` directory that Logseq recovers deleted pages from.

## Limitations

This library is limited to working with Markdown files. As the library provides
an AST for the content there might be some issues with formatting that comes
out wrong after having been read and saved again.

If this happens to you, please do open an issue with an example of content
that is causing the issue.

## License

This project is licensed under the MIT license, see [LICENSE](LICENSE).

logseq-go

logseq-go 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

logseq-go

logseq-go 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README