Update documents

cuigh · Apr 12, 2022 · 87dc590 · 87dc590
1 parent 1d18ef5
commit 87dc590
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -56,3 +56,4 @@ Please follow the [Documentation](https://cuigh.com/obelisk). As you might expec
 - [x] Search
 - [x] Graph
 - [x] Back links
+- [x] Tag links
diff --git a/README_zh.md b/README_zh.md
@@ -55,4 +55,5 @@ Obelisk 是一个 Markdown 文档库发布工具，它能够简单、快速的
 - [x] Theme
 - [x] Search
 - [x] Graph
-- [x] Back links
+- [x] Back links
+- [x] Tag links
diff --git a/docs/01 Quick Start.md b/docs/01 Quick Start.md
@@ -29,12 +29,18 @@ In order to simplify use, Obelisk follows the principle that convention is highe
 
 ### Navigation
 
-By default, navigation menus are sorted by file name, but this is probably not what you want. When the name of a file or folder starts with a number, Obelisk will automatically extract the number as the sequence number, and then sort it in ascending order. The serial number of all file names that do not start with a number is set to 999 by default. After extracting the sequence number, Obelisk will also carefully remove the sequence number from the title to make the navigation menu and URL look more comfortable. Examples are as follows:
+By default, Obelisk use filename as menu title and navigation menus are sorted by file name, but this is probably not what you want. Obelisk supports three ways to process page paths. You can configure `path_formatter` in `obelisk.yml` file.
 
-| Source Name         | Target Name        |
-| ------------------- | ------------------ |
-| 00 Home.md          | home.html          |
-| 01 Reading Notes.md | reading-notes.html |
+- **kebab**: With this value, Obelisk will convert filename to lower case and replace whitespace with strikethrough. This is the default.
+- **smart**: When the name of a file or folder starts with a number, Obelisk will automatically extract the number as the sequence number, and then sort it in ascending order. The serial number of all file names that do not start with a number is set to 999 by default. After extracting the sequence number, Obelisk will also carefully remove the sequence number from the title to make the navigation menu and URL look more comfortable. 
+- **none**: Convert filename to lower case only.
+
+For example:
+
+| Source Name         | Kebab                 | Smart              | None                  |
+| ------------------- | --------------------- | ------------------ | --------------------- |
+| 00 Home.md          | 00-home.html          | home.html          | 00 home.html          |
+| 01 Reading Notes.md | 01-reading-notes.html | reading-notes.html | 01 reading notes.html |
 
 ### URL
 
@@ -51,6 +57,9 @@ paths:
 
 Obelisk will check whether the following files exist in the document library in turn. If it can be found, it will be automatically set as the favicon of the website.
 
+- favicon.ico
+- favicon.png
+- favicon.svg
 - assets/favicon.ico
 - assets/favicon.png
 - assets/favicon.svg
@@ -63,11 +72,15 @@ Similar to favicon, Obelisk will check whether the following image files exist i
 
 - assets/logo.png
 - assets/logo.svg
+- logo.png
+- logo.svg
 
 ### Ignore Path
 
 You may want to hide some directories or files of the document library when publishing, such as unfinished drafts or attachments. Obelisk supports ignoring the specified folders. The files in these directories will not be output as documents into HTML pages or appear in the navigation menu (but will not affect the reference of other pages to it as resource files). If you do not configure the document library, Obelisk will ignore the following directories by default.
 
-- assets
-- templates
-- attachments
+- assets/*
+- templates/*
+- attachments/*
+- *.css
+- *.js
diff --git a/docs/03 Roadmap.md b/docs/03 Roadmap.md
@@ -36,6 +36,7 @@ kanban-plugin: basic
 - [x] Search
 - [x] Graph
 - [x] Back links
+- [x] Tag links
 
 
 

diff --git a/docs/04 Changelog.md b/docs/04 Changelog.md
@@ -4,6 +4,15 @@ layout: timeline
 
 # Changelog
 
+## v0.7.0 @{2022-04-12}
+- Change default path formatter from `smart` to `kebab`
+- Clicking tag will pop up all page links containing that tag
+- Convert vault name to title case if name isn't specificated
+- Use wildcard match to ignore files
+- All JS/CSS files are ignored by default
+- Fix comment parsing
+- Fix styles causing menu items to not be displayed in full
+
 ## v0.6.0 @{2022-04-08}
 - Add support for timeline (Set layout as 'timeline' in metadata)
 - Add timestamp to internal js/css resources

diff --git a/docs/assets/document.png b/docs/assets/document.png
diff --git a/docs/obelisk.yml b/docs/obelisk.yml
@@ -1,6 +1,8 @@
 name: Obelisk
+version: v0.7.0
 url: https://github.com/cuigh/obelisk
 lang: en
 copyright: "© 2021-2022 cuigh. All rights reserved."
 ignores:
   - assets
+path_formatter: smart