joplin-plugin-outline/README.zh-CN.md

<div align="center"> <h1>Joplin Outline Plugin</h1> <i>This is a outline plugin for <a href="https://github.com/laurent22/joplin">Joplin</a>. Refer to <a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/toc/">j

<div align="center">
  <h1>Joplin Outline Plugin</h1>
  <i>这是一个为 <a href="https://github.com/laurent22/joplin">Joplin</a> 提供 outline 功能的插件. 受 <a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/toc/">joplin toc</a> 启发。</i>
  <p align="center">
    <a href="README.md">English</a>
    ·
    <a href="README.zh-CN.md">简体中文</a>
    <br />
  </p>
  <p>
    <a href="https://github.com/cqroot/joplin-outline/actions">
      <img src="https://github.com/cqroot/joplin-outline/workflows/test/badge.svg" alt="Action Status" />
    </a>
    <img src="https://img.shields.io/github/issues/cqroot/joplin-outline" />
    <img src="https://img.shields.io/github/license/cqroot/joplin-outline" />
    <img src="https://img.shields.io/npm/v/joplin-plugin-outline?label=version" />
    <img src="https://img.shields.io/github/downloads/cqroot/joplin-outline/total?label=github%20downloads" />
    <img src="https://img.shields.io/npm/dt/joplin-plugin-outline?label=npm%20downloads" />
  </p>
  <hr>
</div>


![screenshot](.github/screenshot.png)

## 特性

- 支持 atx 风格的标题（`#`），不支持 setext 风格的标题（`---`，`===`）。
- 支持右键拷贝 markdown 内链。
- 支持大纲折叠。
- 支持大纲自动编号。
- 支持自定义界面风格。
- 支持各级标题前增加自定义符号。
- 支持在编辑模式下跳转到标题位置。（由 [@jerrylususu](https://github.com/jerrylususu/joplin-outline) 贡献）

## 文档

- [定制面板风格](https://github.com/cqroot/joplin-outline/wiki/Custom-panel-style)

## 需求

- Joplin 1.3.15 或更高以支持插件。

## 安装

拷贝 outline.jpl 文件到你的 plugins 目录中。outline 插件会在重启应用后自动加载。

## 社区

[A markdown outline sidebar plugin for Joplin](https://discourse.joplinapp.org/t/a-markdown-outline-sidebar-plugin-for-joplin/13364)

[Toc as the sidebar](https://discourse.joplinapp.org/t/toc-as-the-sidebar/5979/64)

## 贡献者

<a href="https://github.com/cqroot/joplin-outline/graphs/contributors">
  <img src="https://contributors-img.web.app/image?repo=cqroot/joplin-outline&max=500" />
</a>