From 7d5ed8cbfc4ebad59200305f84b97c70adfccc2c Mon Sep 17 00:00:00 2001 From: Shotaro Aoki Date: Sat, 22 Jun 2024 17:05:08 +0900 Subject: Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) 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: .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. search screenshot + +### Support `#+ATTR_HTML` keyword in images + +By writing the #+ATTR_HTML keyword for an image, it will be set as HTML attributes for the `` tag. + +```org +#+ATTR_HTML: :alt org-mode-unicorn :width 280px :align right +[[./img/org-mode-unicorn.svg]] +``` + +HTML attributes example screenshot + +## 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 .db +``` + -- cgit