README.md

---

---

简体中文 | English

---

SiYuan Custom Block

A plugin for SiYuan Note that can use custom block attributes to style blocks.

PREVIEW

Q & A

1. If I am unable to click on a block label in the list map view, how do I open the block menu?

   Use the shortcut key Shift + ↑ to select the specific block, then use the shortcut key Ctrl + / to open the block menu for that block.

INTRODUCTION

Function Introduction

Use Block Menu > Plugins > Custom Block Styles to configure the supported styles for the selected block.

Menu Item Name	Block Attribute	Function Introduction	Document Block	Super Block	Quote Block	List Block	List Item	Heading Block	Paragraph Block	Formula Block	Table Block	Code Block	HTML Block	Divider	Audio Block	Video Block	Iframe Block	Widget Block	Embed Block
Block Style	style	Customize the style attribute of the block For more details, please refer to: style - HTML: HyperText Markup Language | MDN		√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√
Full Width Display	block-width:full	Set the width of the block to the width of the document													√	√	√	√
Full Screen Display	None	Display the block in full screen	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√
Scroll Display	block-render:scroll	Document Block: Display vertical scrollbar for blocks that exceed a certain height in this document Other Blocks: Display vertical scrollbar for the block if it exceeds a certain height	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√
Danmaku	block-render:danmaku	Document Block: Display all blocks in this document as danmaku Other Blocks: Display the block as danmaku	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√
Display Block ID	block-render:id	Document Block: Display block ID for all blocks in this document Other Blocks: Display block ID for the block and its subblocks	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√
Display Block Index	block-render:index	Display the index of top-level blocks in the document	√
Display Block Content	block-render:content	Document Block: Display hidden content for all blocks in this document Other Blocks: Display hidden content for all blocks within the block Display link address for hyperlinks Display formula text for inline formulas Display note text for inline notes Display formula text for formula blocks Display corresponding text for other renderable blocks	√	√	√	√	√	√	√	√	√	√	√						√
Display Block Outline	block-render:outline	Document Block: Display outline for all blocks in this document Other Blocks: Display outline for this block	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√
Layout Mode	block-writing-mode:vertical-rl block-writing-mode:vertical-lr	Document Block: Switch the writing mode for all blocks in this document Other Blocks: Switch the writing mode for the block and its subblocks vertical-rl: Display text vertically from right to left vertical-lr: Display text vertically from left to right	√	√	√	√	√	√	√		√
Read Only Mode	block-user-modify:read-only	Disable edit the block and its sub-blocks		√	√	√	√	√	√	√	√	√	√	√	√	√	√	√	√
Table - Default Width	None	Default style Columns in the table without manually adjusted width will not wrap									√
Table - Auto Width	block-table-width:auto	Table maximum width is the same as the width of the document Content in table cells wraps automatically									√
Table - Equal Width	block-table-width:equal	All table cells have fixed width									√
List - Default View	None	Default style Document Block: Display all lists in this document as an outline List Block: Display the list as an outline	√	√	√	√													√
List - Mindmap View	block-list-view:map	Document Block: Display all lists in this document as a mind map List Block: Display the list as a mind map	√	√	√	√													√
List - Table View	block-list-view:table	Document Block: Display all lists in this document as a table List Block: Display the list as a table	√	√	√	√													√
List - Board View	block-list-view:board	Document Block: Display all lists in this document as a board List Block: Display the list as a board	√	√	√	√													√
Export - Enable Style	block-export:true	Document Block: Enable styles for this plug-in when exporting to an image or PDF	√
Export - Disable Style	None	Document Block: Disable styles for this plug-in when exporting to an image or PDF	√

Settings Introduction

• General Settings

  • Reset Settings Options

    • This is a button

    • Reset all settings options to their default values

    • Clicking this button will trigger a confirmation dialog

      • Clicking the confirm button in the dialog will reset all options of this plugin to their default values and automatically refresh the current interface

• Menu Settings

  • Menu

    • This is a switch
    • Default state: On
    • Turn off the switch to disable the corresponding menu items

  • Style

    • This is a switch
    • Default state: On
    • Turn off the switch to disable the built-in styles of the plugin
    • If the theme is compatible with the corresponding style, you can turn off this switch

CHANGELOG

CHANGELOG.md