docs: add README.github.md

any-block · Jan 20, 2025 · d1ba746 · d1ba746
1 parent 12444b3
commit d1ba746
Showing 1 changed file with 145 additions and 0 deletions.
diff --git a/docs/README.github.md b/docs/README.github.md
@@ -0,0 +1,145 @@
+# README
+
+## Lightspot (亮点)
+
+![Obsidian plugin](https://img.shields.io/endpoint?url=https%3A%2F%2Fscambier.xyz%2Fobsidian-endpoints%2Fany-block.json) ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/LincZero/obsidian-any-block)
+
+A Obsidian Plugin. You can flexibility to create a 'Block' by some means. It also provides some useful features, like `list to table` and so on.
+
+一个Obsidain插件。您可以通过某种方式灵活地创建一个“块”。它还提供了一些有用的功能，如“列表转表格”等。
+
+This is a **【Syntax free, Extensible、Powerful and flexible、Multi-platform】** Markdown block extension rendering plugin
+
+（这是一个 **【无语法、可扩展、灵活强大、多平台】** 的 Markdown 块扩展渲染插件）
+
+- Syntax free (无语法)
+    - No new syntax、Syntax-free intrusion (没有新语法、没有语法入侵)
+	- 这也导致没有过度的插件依赖。我认为好的插件不应该导致 —— 当你用了一段时间插件后，离开该插件会导致原来的内容变形，不可读或维护
+- Extensible (可扩展性)
+    - Facilitate secondary development （插件方便二次开发）
+- Powerful and flexible (灵活且强大)
+    - 选择器：选择范围灵活，六种选择方式，简单易用
+	- 处理器：丰富多样、功能强大、扩展性强
+- Multi-platform (多平台)
+    - Obsidian
+	- Blogs such as vuepress/vitepress that support markdown-it parsing
+	- V3版本重构并迁移到markdown-it插件，可以使Obsidian和你发布的VuePress/VitePress保持高度一致性（至于在VuePress上的效果如何，可以点击上面的第一个链接查看）
+
+## More Links (相关链接)
+
+- en
+	- Related links：tutorial、use skill、contribution、secondary development. Documentation is **multilingual** (zh/en), don't worry.
+	- [Online Wiki - github.io](https://linczero.github.io/MdNote_Public/ProductDoc/AnyBlock/)
+	- [Online Effects warrior/Tutorial - github.io](https://linczero.github.io/MdNote_Public/ProductDoc/AnyBlock/README.show.md), You can learn how to use it by switching between tabs.
+	- [Docs Repo - github](https://github.com/LincDocs/MdNote_Public/tree/main/ProductDoc/AnyBlock), You can translate or supplement documents here
+	- Alternate site links：When the website link to this article fails, try replacing `linczero.github.io` with `linczero-github-io.pages.dev` in the url
+- zh
+	- 相关链接：教程、使用技能、贡献、二次开发。文档是**多语言**的（zh/en），不用担心
+	- [在线文档 - github.io](https://linczero.github.io/MdNote_Public/ProductDoc/AnyBlock/)
+	- [在线效果展示/教程 - github.io](https://linczero.github.io/MdNote_Public/ProductDoc/AnyBlock/README.show.md), 你可以通过切换里面的标签页来学习用法
+	- [文档对应的仓库 - github](https://github.com/LincDocs/MdNote_Public/tree/main/ProductDoc/AnyBlock), 你可以在此翻译或补充文档
+	- 备用网站链接：如果网站失效，则将网站链接部分的 `linczero.github.io` 替换成 `linczero-github-io.pages.dev` 就可以了
+	  （**本文的默认网站链接指向 github.io，如果国内有不能访问的朋友，那么大概率需要做这一步**）
+
+## Effects warrior (效果展示)
+
+`multiWay table`/`multiCross table`/`Cross table` (`多叉表格`/`跨行表格`)
+
+![](./assets/Pasted%20image%2020240808202548.png)
+
+![](./assets/Pasted%20image%2020240808203055.png)
+
+`ListTable`/`TreeTable`/`TreeGrid` (`列表格`/`树型表格`)
+
+![](./assets/Pasted%20image%2020240808203143.png)
+
+Optimized list (优化列表)
+
+The essence is "listtable" based on the addition of a mock list style (本质是 "列表格" 的基础上增加仿列表样式)
+
+![](./assets/listtable_likelist.png)
+
+Dir Tree (目录树)
+
+The essence is "listtable" based on the addition of imitation directory style (本质是"列表格"的基础上增加仿目录样式)
+
+![](./assets/Pasted%20image%2020240808203216.png)
+
+ASCII Dir Tree (ascii 目录树) 
+
+![](./assets/Pasted%20image%2020240808203232.png)
+
+  WBS (Work Breakdown Structure, 工作分解结构)
+
+![](./assets/Pasted%20image%2020240808203252.png)
+
+timeline (时间线)
+
+![](./assets/Pasted%20image%2020240808203455.png)
+
+tabs & card (标签页和卡片)
+
+![](./assets/tag%20and%20card.png)
+
+mermaid flow (mermaid流程图)
+
+![](./assets/Pasted%20image%2020240808203517.png)
+
+plantuml mindmap (plantuml 思维导图)
+
+![](./assets/Pasted%20image%2020240808203534.png)
+
+nodes (ab mindmap) (转节点树图，AnyBlock版思维导图)
+
+![](./assets/list2node.png)
+
+markmap mindmap (markmap 思维导图)
+
+![](./assets/Pasted%20image%2020240808203605.png)
+
+mermaid mindmap (mermaid 思维导图)
+
+![](./assets/Pasted%20image%2020240808203621.png)
+
+[more……](https://linczero.github.io/MdNote_Public/%E4%BA%A7%E5%93%81%E6%96%87%E6%A1%A3/AnyBlock/)
+
+## Effects warrior - old (旧效果展示)
+
+Here are some of the more common processors:
+- list2table  (2datatable)
+- list2listtable
+- list2mermaid  (graph LR)
+- list2mindmap  (mermaid v9.3.0 mindmap)
+- list2tab
+- list2timeline
+- title2list + list2somthing
+
+![](./assets/list2table.png)
+
+![](./assets/list2tableT.png)
+
+![](./assets/list2lt.gif)
+
+![](./assets/list2tab.gif)
+
+![](./assets/list2mermaid.png)
+
+![](./assets/list2mindmap.png)
+
+![](./assets/titleSelector.png)
+
+![](./assets/addTitle.png)
+
+![](./assets/scroll.gif)
+
+![](./assets/overfold.png)
+
+![](./assets/flod.gif)
+
+![](./assets/heimu.gif)
+
+![](./assets/userProcessor.png)
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=LincZero/obsidian-any-block&type=Date)](https://star-history.com/#LincZero/obsidian-any-block&Date)