aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShotaro Aoki <ikoamu@gmail.com>2024-06-22 17:05:08 +0900
committerGitHub <noreply@github.com>2024-06-22 17:05:08 +0900
commit7d5ed8cbfc4ebad59200305f84b97c70adfccc2c (patch)
treec4e43a0065a238c0c789b2f33c4fd7929a88ac74
parentea2c790c8ca1d416ef2744e9e13b3ff651c68e84 (diff)
Update README.md
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0e7ab3f..d613a68 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@ This action generates a static site for [org-roam-ui](https://github.com/org-roa
It also allows deployment to GitHub Pages.
(See https://ikoamu.github.io/publish-org-roam-ui/)
+By using this, you can easily publish your org-roam as a digital garden 🌱
+
## How to Use
First, please manage the .org files in `org-roam-directory` and the db file in org-roam using git.
@@ -32,7 +34,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
```
@@ -131,3 +133,25 @@ Sites generated by publish-org-roam will have code blocks highlighted.
Search by title, tags, or content and instantly open a node.
<img width="533" alt="search screenshot" src="https://github.com/ikoamu/publish-org-roam-ui/assets/38206334/26f20ce8-1dbf-4377-bee2-fa14da7de105">
+
+### Support `#+ATTR_HTML` keyword in images
+
+By writing the #+ATTR_HTML keyword for an image, it will be set as HTML attributes for the `<img>` tag.
+
+```org
+#+ATTR_HTML: :alt org-mode-unicorn :width 280px :align right
+[[./img/org-mode-unicorn.svg]]
+```
+
+<img width="533" alt="HTML attributes example screenshot" src="https://github.com/ikoamu/publish-org-roam-ui/assets/38206334/75c32431-15c7-4fad-a019-039a3a2c6e4e">
+
+## Local Build
+
+If you don't want to upload org files to the repository, you can obtain the same site as generated by GitHub Actions by running the site generation script locally.
+
+```bash
+git clone git@github.com:ikoamu/publish-org-roam-ui.git
+cd publish-org-roam-ui
+./local.sh /path/to/org-roam-dir <org-roam-filename>.db
+```
+