# logseq-long-form

**Repository Path**: sethyuan/logseq-long-form

## Basic Information

- **Project Name**: logseq-long-form
- **Description**: A long form editing experience for Logseq.
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2023-08-04
- **Last Updated**: 2024-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

English | [中文](README.zh.md)

# logseq-plugin-long-form

A long form editing experience for Logseq.

## How to Install

### Plugin Marketplace

Search for it in the plugin marketplace and install it from there.

### Manual Installation

1. Download the newest zip file from the [Releases](https://github.com/sethyuan/logseq-long-form/releases) page.
1. Unzip the zip file into the folder where you want to store the plugin.
1. Turn on the developer mode in Logseq. ![](./assets/developer_mode.png)
1. Load the unzipped folder (named `logseq-long-form`) by clicking on the `Load unpacked plugin` button on the plugins modal. ![](./assets/load_plugin.png)
1. You should now see the plugin being installed. ![](./assets/plugin_installed.png)

## Features

- An globally toggleable long-form mode offering a nice long-form writing experience.
- Automatic indentation management (supports indent/outdent for both markdown headings and auto headings).
- A configurable shortcut for toggling auto heading.
- Visual effects to clearly indicate block nesting relationships.
- Easy writing of ordered and unordered lists.
- Special tags (`#.indent` and `#.indent-children`) for visually indenting a block or its children.
- Each block can have a meta block, where you can write anything you normally would not like to display.
- The best markdown export you can find on Logseq, better than the built-in one.
- An accurate word count that's not based on the markdown but what you actually see on the screen.
- Special formatting for interstitial journal times.
- Several content layouts.

## Usage

### Enter/Exit Long Form Mode

https://github.com/sethyuan/logseq-long-form/assets/3410293/9a1a2689-e606-4ec7-a4dc-e899d6480473

### Headings

#### Markdown Headings

https://github.com/sethyuan/logseq-long-form/assets/3410293/fd82b82a-a232-4ec7-83bf-96ba4c725bd4

#### Auto Headings

https://github.com/sethyuan/logseq-long-form/assets/3410293/ef92672a-8692-4665-ab6c-27938cebe056

### Visual Aids

https://github.com/sethyuan/logseq-long-form/assets/3410293/683107a9-1d68-42c2-a41c-18f4e7b8b00c

### Lists

https://github.com/sethyuan/logseq-long-form/assets/3410293/428e206f-cc8e-4714-a59e-4365daa6eef2

### Visual Indentation

https://github.com/sethyuan/logseq-long-form/assets/3410293/3d6f2009-60b8-492a-a6c5-1ce655fb6638

### Long Form + TOC Generator

https://github.com/sethyuan/logseq-long-form/assets/3410293/0147a54e-9dee-4f6d-99eb-9bb909d4303d

### Word Counting

https://github.com/sethyuan/logseq-long-form/assets/3410293/27f10d90-1ac7-4132-9ca2-5f0694794590

### Export to Markdown

https://github.com/sethyuan/logseq-long-form/assets/3410293/5a43a384-34aa-47e2-a86b-fa2f9c22bebe

### Meta Block

https://github.com/sethyuan/logseq-long-form/assets/3410293/fc8fedee-ddcf-4f71-924a-31b1fa1bd6c7

### Manual Grouping

https://github.com/sethyuan/logseq-long-form/assets/3410293/599dcff4-98e8-404f-be51-e96908a72494

### Interstitial Journaling

https://github.com/sethyuan/logseq-long-form/assets/3410293/fbc31684-55a0-4c6a-9a02-d0a641117420

### Content Layouts

https://github.com/sethyuan/logseq-long-form/assets/3410293/0cdaaa07-2516-432a-9541-c5e361a630f3

https://github.com/sethyuan/logseq-long-form/assets/3410293/06f76534-6d95-45dc-9d57-06bed84a4666

## Join the community

Join the Discord channel [here](https://discord.gg/E7TA5rUuKE) where we discuss everything related to the plugin.