Skip to content

Commit 1245f21

Browse files
committed
add some user docs
1 parent 9c84fc3 commit 1245f21

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

.gitattributes

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +0,0 @@
1-
/docs/**/* -diff
2-
/orgx/**/* -diff

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ note.org
2626
.cache
2727
.clj-kondo
2828
/orgx
29-
/docs
3029
.cljc
3130
/result
3231
/workspace

docs/user-docs.org

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
* Writting a Blog
2+
3+
** Metadata
4+
5+
A blog file supported the following metadata:
6+
7+
+ DATE :: published date, could be in the format of <2026-01-24 Sat> or a ISO 8601 timestamp like 2026-01-23T20:30:30Z
8+
+ PUBLISHED_DATE :: has the same format as DATE, takes priority over *DATE*
9+
+ MODIFIED_DATE :: last modified date, has the same format as *DATE*
10+
+ TITLE :: title of the blog, the sanitized version of the title also served as the unique id of the blog.
11+
+ CATEGORY :: category
12+
+ ORGX :: more about orgx on [[https://coruscation.net/blogs/something-like-mdx-but-with-clojure-and-org-mode-for-my-personal-blog--part-i.html][Something Like MDX but with Clojure and Org-Mode for My Personal Blog: Part I]]
13+
14+
#+begin_comment
15+
If published date or modified date are not presented, they are determinnted using a heuristic method. Namely through git commit history (if present) or linux file ~stat~.
16+
#+end_comment

0 commit comments

Comments
 (0)