From db2bf1a6dbe2e20b676ecf421f14bfca220e6a4b Mon Sep 17 00:00:00 2001
From: ikoamu <ikoamu@gmail.com>
Date: Sun, 7 Apr 2024 20:08:01 +0900
Subject: update document

---
 README.md                                      | 40 +++++++++++++++++++++++++-
 example/20240316194158-publish_org_roam_ui.org |  2 +-
 2 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d720e0f..c33c493 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,37 @@ You can create an `img` directory directly under the repository and display imag
 [[./img/test.png]]
 ```
 
+### Store org files in subdirectory
+
+Set `org-roam-directory` to store org files in a subdirectory instead of directly under the repository.
+
+```yml
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate org-roam-ui page
+        uses: ikoamu/publish-org-roam-ui@main
+        with:
+          org-roam-directory: org-files
+          org-roam-db-filename: org-roam.db
+```
+
+```
+YourRepository
+├── .github/workflows
+├── org-files
+│   ├── img
+│   │   ├── img1.png
+│   │   └── img2.png
+│   ├── org-roam.db
+│   ├── roam1.org
+│   ├── roam1.org
+│   └── ・・・
+├── README.org
+└── ・・・
+```
+
 ### Setting site tile
 
 You can change the title of the site by specifying `site-tile`. (The default is ORUI)
@@ -85,9 +116,16 @@ jobs:
           site-title: my org-roam!
 ```
 
-## code highlighting
+## Customized org-roam-ui
+
+Sites generated by publish-org-roam-ui have additional features implemented that are not in the original org-roam-ui.
+
+### Code highlighting
 
 Sites generated by publish-org-roam will have code blocks highlighted.
 
 <img width="840" alt="スクリーンショット 2024-03-22 21 12 34" src="https://github.com/ikoamu/publish-org-roam-ui/assets/38206334/446d2575-8079-473f-a886-be2b2bec03be">
 
+### Search feature
+
+Search by title, tags, or content and instantly open a node.
diff --git a/example/20240316194158-publish_org_roam_ui.org b/example/20240316194158-publish_org_roam_ui.org
index 2d07354..2851c42 100644
--- a/example/20240316194158-publish_org_roam_ui.org
+++ b/example/20240316194158-publish_org_roam_ui.org
@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Generate org-roam-ui page
-        uses: ikoamu/org-roam-ui-hosting@main
+        uses: ikoamu/publish-org-roam-ui@main
         with:
           org-roam-db-filename: <org-roam-filename>.db
 #+end_src
-- 
cgit