https://github.com/dimfeld/export-logseq-notes

Export notes from Logseq or Roam to HTML for use in a static site.
https://github.com/dimfeld/export-logseq-notes

logseq publishing

Last synced: 2 months ago
JSON representation

Export notes from Logseq or Roam to HTML for use in a static site.

• Host: GitHub
• URL: https://github.com/dimfeld/export-logseq-notes
• Owner: dimfeld
• License: mit
• Created: 2021-01-08T09:08:40.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-01T08:16:25.000Z (10 months ago)
• Last Synced: 2024-10-07T07:06:58.119Z (3 months ago)
• Topics: logseq, publishing
• Language: Rust
• Homepage:
• Size: 310 KB
• Stars: 45
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Logseq Note Exporter

This is a program to take a Logseq directory and convert it into web pages. I'm currently using this to

populate much of the content on [my website](https://imfeld.dev/).

Note: Most everything below is out of date. I'll be rewriting the README to accurately reflect the addition of scripting and other new capabilities. For now, the easiest way to see how to use this is to look at [the configuration I use on my website](https://github.com/dimfeld/website).

## Features

- Selective export: Include and exclude pages based on presence of tags in each page

- Optionally omit lines that only contain links/tags to pages that aren't included.

  - So tag-only lines like `#Articles #Done #Thinking` don't clutter up the page.

- Support block references, block embeds, and page embeds.

- Supports output templates: complete HTML page, text with front matter, or anything else!

- Gathers hashtags in a page for use in the output template 

  - This is configurable to use either a specific "Tags" attribute, or hashtags anywhere in a page.

  - Tags can be excluded

This program also supports operating on a Roam Research EDN export, though I'm not maintaining that support so the

parsing may stop working if the Roam EDN format changes enough.

## Configuration

Primary configuration is through a TOML file. You can find an [annotated config file here](https://github.com/dimfeld/export-logseq-notes/blob/master/export-roam-notes.toml) and

modify it for your needs.

The program also supports command line arguments to override settings in the config file. `export-logseq-notes --help` will show

the arguments available.

## Notable features planned

- [X] Option to only export pages with a certain tag

- [X] When a page links to another exported page, the output contains a link.

- [X] Expands block embeds

- [X] Link block references to original block

- [X] Translate namespaces into nested directories

- [ ] Option to show backlinks at bottom

## Acknowledgements

- [edn-rs](https://github.com/naomijub/edn-rs) for EDN parsing

- [nom](https://github.com/Geal/nom) for making it easy to write custom parsers

- The Svelte syntax file is imported from `https://github.com/corneliusio/svelte-sublime`.