[1.2.0] new release

CHANGELOG.md

@@ -149,4 +149,13 @@ typo
 
 #### Other
 
-- A better search field
+- A better search field
+
+### [1.2.0] - 2023-10-13
+
+#### Add
+
+- Region and tag support #43
+ - Region and tag symbols
+ - Syntax highlight
+ - Region folding

README.md

@@ -13,35 +13,95 @@ A visual, interactive outline map that combines the clarity of the outline with
 
 ## Features
 
-- ### Automatically scroll, expand and collapse the outline tree
+### Follow
+
+Automatically scroll, expand and collapse the outline tree when the cursor moves or the viewport scrolls.
+
 ![follow](screenshots/follow.gif)
-- ### Navigate through the outline
+
+### Navigation
+
+You can navigate to the symbol by clicking on the outline node like the built-in outline.
+
+Keyboard navigation is also supported.
+
 ![navigation](screenshots/nav.gif)
-- ### Flag diagnostics
+
+### Diagnostics
+
+Show diagnostics of the current file.
+
 ![Flag diagnostics](screenshots/diagnostics.gif)
-- ### Search the outline (`<Alt-l>`)
- append `@` to filter by symbol kind
- - `/<exp>`: Normal
- - `=<exp>`: RegExp
- - `?<exp>`: Fuzzy
+
+### Search
+
+default keybinding: `<Alt-l>`
+
+Search for symbols in the current file. You can use the following syntax to achieve different search effects:
+
+- `/<exp>`: Normal search
+- `=<exp>`: Regex
+- `?<exp>`: Fuzzy search
+
+You can append `@` to filter by symbol kind before the search expression.
 
 ![Search](screenshots/search.gif)
 
+### Region and tag
+
+Supports region and tag syntax
+
+You can define regions to group code symbols anywhere in the code (usually comments), or tags to mark locations.
+
+#### Grammar 
+
+```md
+#region <name> <comment>
+#tag <name> <comment>
+#endregion <name>
+```
+
+#### Features
+- Allows customizing identifiers for regions and labels.
+- Tag syntax highlighting (semantic highlighting needs to be enabled)
+- Region folding
+
+![region and tag](screenshots/region.png)
+
 ---
 
 ## Configuration
 Changes will take effect after restarting the outline view
-- `outline-map.color`: color table for specific symbols
+
+### Customization
+
+- `outline-map.color`: Color table for specific symbols
+
+- `outline-map.customFont`: Custom font for the outline. 
+
+ Syntax: `[ <family-name> | <generic-family> ]#`
+
+- `outline-map.customCSS`: Custom css for the outline. The css will be injected into the outline's webview.
+
+### Behavior
 
 - `outline-map.follow`: Scroll the outline when the cursor moves or the viewport scrolls
 
 - `outline-map.hiddenItem`: Choose items you do not want to see in the outline.
 
 - `outline-map.defaultMaxDepth`: Set the default maximum depth of the outline tree. Set this to non-zero to enable the depth button `>` & `<`.
 
-- `outline-map.customFont`: Custom font for the outline. Syntax: `[ <family-name> | <generic-family> ]#`
+### Region and tag
+
+- `outline-map.region.enabled`: Enable region and tag support
 
-- `outline-map.customCSS`: Custom css for the outline. The css will be injected into the outline's webview.
+- `outline-map.region.startRegion`: The start of a region.
+
+- `outline-map.region.endRegion`: The end of a region.
+
+- `outline-map.region.tag`: The start of a tag.
+
+- `outline-map.region.highlight`: Enable region and tag syntax highlighting
 
 ## Commands
 - `outline-map.toggleSearch`: Switch the visibility of search and navigation field. Default keybinding: `<Alt-l>`
@@ -53,9 +113,8 @@ Changes will take effect after restarting the outline view
 ---
 
 ## Suggestion: move view to secondary side panel (vscode ^1.64)
-![Initialize settings](images/init.gif)
 
-> Outline Map relies on (vscode || other extensions) to provide symbol information
+> Outline Map relies on vscode or other extensions to provide symbol information
 > 
 >  Refer to the following links for more information: [vscode-code-outline/ language-support](https://github.com/patrys/vscode-code-outline#language-support)
 

README_ZH_CN.md

@@ -12,36 +12,94 @@
 
 ## 特性
 
-- ### 自动滚动, 展开与折叠大纲
+### 跟随
+
+根据代码视图或光标位置自动滚动, 展开与折叠大纲。
+
 ![follow](screenshots/follow.gif)
-- ### 快速导航
+
+### 导航
+
+点击大纲节点可跳转至对应位置, 也支持键盘导航。
+
 ![navigation](screenshots/nav.gif)
-- ### 标记Error与Warning
+
+### 诊断
+
+显示当前文件的错误与警告。
+
 ![Flag diagnostics](screenshots/diagnostics.gif)
-- ### 搜索 (`<Alt-l>`)
- 在搜索框中输入 `@` 以按符号类型过滤
- - `/<exp>`: 正常搜索
- - `=<exp>`: 正则表达式
- - `?<exp>`: 模糊搜索
+
+### 搜索
+
+默认键位: `<Alt-l>`
+
+在当前文件中搜索符号. 可以使用以下语法实现不同的搜索效果:
+
+- `/<exp>`: 正常搜索
+- `=<exp>`: 正则表达式
+- `?<exp>`: 模糊搜索
+
+在搜索前输入 `@` 以按符号类型过滤
 
 ![Search](screenshots/search.gif)
 
----
+### 区域与标签
+
+支持区域与标签语法
+
+可以在代码中的任何位置定义区域以分组代码符号(通常是注释), 或者定义标签以标记位置.
+
+#### 语法
+
+```md
+#region <name> <comment>
+#tag <name> <comment>
+#endregion <name>
+```
+
+#### 功能
+
+- 可折叠或展开区域
+- 标签和区域语法高亮
+- 自定义区域与标签的标识符
+
+![region and tag](screenshots/region.png)
 
 ## 设置
+
 更改将在重启大纲视图后生效
 
+### 样式
+
 - `outline-map.color`: 为特定符号设置颜色
 
+- `outline-map.customFont`: 设置自定义字体. 
+
+ 语法: `[ <family-name> | <generic-family> ]#`
+
+- `outline-map.customCSS`: 设置自定义CSS. 这些CSS会被插入大纲的Webview视图
+
+### 行为
+
 - `outline-map.follow`: 设置大纲视图自动跟随光标|视口
 
 - `outline-map.hiddenItem`: 选择隐藏大纲视图中的项目
 
 - `outline-map.defaultMaxDepth`: 设置默认最大深度. 将其设置为正值以启用命令按钮 `>` & `<`.
-
-- `outline-map.customFont`: 设置自定义字体. 语法: `[ <family-name> | <generic-family> ]#`
 
-- `outline-map.customCSS`: 设置自定义CSS. 这些CSS会被插入大纲的Webview视图
+### 区域与标签
+
+- `outline-map.region.enabled`: 启用区域与标签功能
+
+- `outline-map.region.startRegion`: 区域的开始标识符
+
+- `outline-map.region.endRegion`: 区域的结束标识符
+
+- `outline-map.region.tag`: 标签的标识符
+
+- `outline-map.region.highlight`: 启用区域与标签的语法高亮
+
 
 ## 命令
 
@@ -56,9 +114,6 @@
 ---
 
 ## 建议: 将视图移至辅助侧栏 (vscode ^1.64)
-![Initialize settings](images/init.gif)
-
----
 
 > Outline Map 依赖于 vscode 或 其他扩展提供符号信息
 >

package.json

@@ -2,7 +2,7 @@
  "name": "outline-map",
  "displayName": "Outline Map",
  "description": "A visual, interactive outline map that combinesAlternative Minimap. the clarity of the outline with the intuitive overview of the minimap. Enhanced version of vscode built-in outline.",
- "version": "1.1.0",
+ "version": "1.2.0",
  "repository": {
  "url": "https://github.com/Gerrnperl/outline-map.git"
  },