https://github.com/sethyuan/logseq-plugin-doc

Show page in a more document like look and provide quick exporting.
https://github.com/sethyuan/logseq-plugin-doc

logseq logseq-plugin

Last synced: 3 months ago
JSON representation

Show page in a more document like look and provide quick exporting.

• Host: GitHub
• URL: https://github.com/sethyuan/logseq-plugin-doc
• Owner: sethyuan
• License: mit
• Created: 2021-12-23T01:00:46.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-24T05:25:20.000Z (7 months ago)
• Last Synced: 2024-06-21T13:30:18.342Z (5 months ago)
• Topics: logseq, logseq-plugin
• Language: JavaScript
• Homepage:
• Size: 10.7 MB
• Stars: 85
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.en.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - sethyuan/logseq-plugin-doc - Show page in a more document like look and provide quick exporting. (others)

README

        
[中文](README.md) | English

# logseq-plugin-doc

Show page in a more document like look and provide quick exporting.

## Usage

https://user-images.githubusercontent.com/3410293/211442242-129978a6-b7a6-41d2-b830-296c814e36e2.mp4

### Inline TOC Generator Support

When exported, links of the inline TOCs will remain usable and all blocks being referenced will also feature an arrow that can go back.

The PDF printed out by using the exported HTML will retain these links.

![toc demo](./toc_demo.gif)

## Shortcuts

You can toggle the document view with the command palette，It's shortcut key is `cmd+shift+d` on macOS, `ctrl+shift+d` on Windows.

## About lists

You can add a `#.ul` tag to a block that is a bullet list, in this way, the plugin will know to format it accordingly. You can also use `#.ul-nested` if it's a nested bullet list what you want.

Similarly, you can use tags that [Ordered Lists plugin](https://github.com/sethyuan/logseq-plugin-ol) can support like `#.ol` or `#.ol-nested` to indicate an ordered list. Logseq's built-in ordered lists are also supported.

Example

![Bullet List](./bullets.png)

## Linked References in newer versions of Logseq

Linked References are dynamically loaded in newer versions of Logseq, be sure to scroll to this part of the page and all its content is loaded and displayed if you want to have this section exported.

## Exporting for complex themes

It's necessary to configure `pluginsDir` in the plugin's settings if you use some complex themes, the style files won't be able to load for exported HTML otherwise.

## Customizing styles for export

You can customize the styles that are applied when exporting via the custom.css file. When exporting, the plugin applies the `.kef-doc-exported` CSS class to the top level, so you can control the styles you want to apply when exporting by prepending this class to your CSS selector. For example:

```css

/* The background color of the exported page is white. */

.kef-doc-exported #main-content-container {

  background: #fff !important;

}

```

## Buy me a coffee

If you think the software I have developed is helpful to you and would like to give recognition and support, you may buy me a coffee using following link. Thank you for your support and attention.