Update documents

cuigh · Apr 8, 2022 · 9c319ec · 9c319ec
1 parent 3c3e1ba
commit 9c319ec
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 [English](https://github.com/cuigh/obelisk) | [中文](https://github.com/cuigh/obelisk/blob/master/README_zh.md)
 
-Obelisk is a publishing tool for markdown document library, which can help you generate HTML documents simply and quickly. In particular, out of personal preference, Obelisk has made a lot of optimization for the [Obsidian](https://obsidian.md) document library, which can be used as an alternative to the official publishing service.
+Obelisk is a publishing tool for markdown document library, which can help you generate HTML documents simply and quickly. In particular, out of personal preference, Obelisk has made a lot of optimization for the [Obsidian](https://obsidian.md) document library, and can be used as an alternative to the official publishing service.
 
 ## Features
 
@@ -11,7 +11,7 @@ Obelisk is a publishing tool for markdown document library, which can help you g
 - Support some mainstream plugins of the Obsidian community
 	- Excalidraw
 	- Banner
-	- Admonition
+	- Kanban
 	- Icon Folder
 	- ……
 
@@ -37,21 +37,21 @@ Please follow the [Documentation](https://cuigh.com/obelisk). As you might expec
 - [x] Callout
 - [x] LaTeX
 - [x] Comment
-- [ ] Embed
+- [x] Embed
 	- [x] Image
 	- [x] Audio
 	- [x] Video
 	- [x] Excalidraw
 	- [x] PDF
-	- [ ] Markdown
+	- [x] Markdown
 - [x] Plugin
 	- [x] Banner
 	- [x] Excalidraw
 	- [x] Admonition
 	- [x] Icon Folder
 	- [x] Kanban
 	- [x] Charts
-	- [ ] Timeline
+	- [x] Timeline
 - [x] Theme
 - [x] Search
 - [x] Graph

diff --git a/README_zh.md b/README_zh.md
@@ -11,7 +11,7 @@ Obelisk 是一个 Markdown 文档库发布工具，它能够简单、快速的
 - 支持 Obsidian 社区的一些主流插件
 	- Excalidraw
 	- Banner
-	- Admonition
+	- Kanban
 	- Icon Folder
 	- ……
 
@@ -37,21 +37,21 @@ Obelisk 是一个 Markdown 文档库发布工具，它能够简单、快速的
 - [x] Callout
 - [x] LaTeX
 - [x] Comment
-- [ ] Embed
+- [x] Embed
 	- [x] Image
 	- [x] Audio
 	- [x] Video
 	- [x] Excalidraw
 	- [x] PDF
-	- [ ] Markdown
+	- [x] Markdown
 - [x] Plugin
 	- [x] Banner
 	- [x] Excalidraw
 	- [x] Admonition
 	- [x] Icon Folder
 	- [x] Kanban
 	- [x] Charts
-	- [ ] Timeline
+	- [x] Timeline
 - [x] Theme
 - [x] Search
 - [x] Graph

diff --git a/docs/00 Home.md b/docs/00 Home.md
@@ -33,4 +33,4 @@ Obelisk is a publishing tool for markdown document library, which can help you g
 ![[graph.png]]
 
 **Extensions**
-![[extension.png]]
+![[extension.png]]
diff --git a/docs/02 Theme.md b/docs/02 Theme.md
@@ -4,7 +4,7 @@ Obelisk fully understood everyone's personalized needs, so it added support for
 
 ## Built in themes
 
-At present, Obelisk has built-in willow and coco themes (since the author is not a professional designer after all, please forgive me if you think the style is not to your taste). To use the built-in theme, you only need to pass the theme name to the theme parameter, as shown below.
+At present, Obelisk has built-in willow and coco themes (Since I'm not a professional designer after all, please forgive me if the style is not to your taste). To use the built-in theme, you only need to pass the theme name to the theme parameter, as shown below.
 
 ```shell
 obelisk build -v /folder/to/vault -o /folder/to/output -t willow

diff --git a/docs/03 Roadmap.md b/docs/03 Roadmap.md
@@ -1,26 +1,47 @@
-## Roadmap
+---
+
+kanban-plugin: basic
+
+---
+
+## Markdown
 
 - [x] CommonMark
 - [x] GFM Extensions
 - [x] Callout
 - [x] LaTeX
 - [x] Comment
-- [ ] Embed
-	- [x] Image
-	- [x] Audio
-	- [x] Video
-	- [x] Excalidraw
-	- [x] PDF
-	- [ ] Markdown
-- [x] Plugin
-	- [x] Banner
-	- [x] Excalidraw
-	- [x] Admonition
-	- [x] Icon Folder
-	- [x] Kanban
-	- [x] Charts
-	- [ ] Timeline
+- [x] Embed: Image
+- [x] Embed: Video
+- [x] Embed: Audio
+- [x] Embed: Excalidraw
+- [x] Embed: PDF
+- [x] Embed: Markdown
+
+
+## Plugin
+
+- [x] Banner
+- [x] Excalidraw
+- [x] Admonition
+- [x] Icon Folder
+- [x] Kanban
+- [x] Charts
+- [x] Timeline
+
+
+## Other
+
 - [x] Theme
 - [x] Search
 - [x] Graph
 - [x] Back links
+
+
+
+
+%% kanban:settings
+```
+{"kanban-plugin":"basic"}
+```
+%%
diff --git a/docs/04 Changelog.md b/docs/04 Changelog.md
@@ -1,9 +1,21 @@
+---
+layout: timeline
+---
+
+# Changelog
+
+## v0.6.0 @{2022-04-08}
+- Add support for timeline (Set layout as 'timeline' in metadata)
+- Add timestamp to internal js/css resources
+- Support markdown embedding of Obsidian vault
+- Turn consecutive images into columns
+
 ## v0.5.1 @{2022-04-06}
 - Fix callout rendering
 - Tasklist supports characters other than 'x' and 'X' now
 - Change search shortcuts of willow theme to '/'
-- Add support for charts plugin
-- Add support for kanban plugin
+- Add support for `obsidian-charts` plugin
+- Add support for `obsidian-kanban` plugin
 - Replace embed mermaid.js and echarts.js to CDN
 
 ## v0.5.0 @{2022-03-29}

diff --git a/docs/assets/extension.png b/docs/assets/extension.png