Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ikoamu/publish-org-roam-ui
Generates a static site for org-roam-ui from org-roam files managed on GitHub. And it is easy to publish to GitHub Pages.
https://github.com/ikoamu/publish-org-roam-ui
digital-garden emacs github-actions github-pages org-roam org-roam-ui
Last synced: about 1 month ago
JSON representation
Generates a static site for org-roam-ui from org-roam files managed on GitHub. And it is easy to publish to GitHub Pages.
- Host: GitHub
- URL: https://github.com/ikoamu/publish-org-roam-ui
- Owner: ikoamu
- License: gpl-3.0
- Created: 2024-01-23T14:28:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-13T11:08:35.000Z (4 months ago)
- Last Synced: 2024-12-08T22:40:55.484Z (about 2 months ago)
- Topics: digital-garden, emacs, github-actions, github-pages, org-roam, org-roam-ui
- Language: JavaScript
- Homepage: https://ikoamu.github.io/publish-org-roam-ui/
- Size: 246 KB
- Stars: 46
- Watchers: 4
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# publish-org-roam-ui
This action generates a static site for [org-roam-ui](https://github.com/org-roam/org-roam-ui) from [org-roam](https://www.orgroam.com/) files managed on GitHub.
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.
```lisp
(setq org-roam-directory "/path/to/org-roam-dir")
(setq org-roam-db-location "/path/to/org-roam-dir/.db")
```
```bash
cd /path/to/org-roam-dir/
git init
```
Then, a static org-roam-ui site is easily generated for the artifact by creating a workflow like the following.
```yml
name: Generate static org-roam-ui page
on:
push:
branches:
- main
jobs:
main:
runs-on: ubuntu-latest
steps:
- name: Generate org-roam-ui page
uses: ikoamu/publish-org-roam-ui@main
with:
org-roam-db-filename: .db
```
Deploy to GitHub Pages by setting `deploy-to-pages` to true.
And sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages.
Under the repositories _Settings > GitHub Pages_ select _Deply from Action_.
```yml
permissions:
contents: read
pages: write
id-token: write
jobs:
main:
runs-on: ubuntu-latest
steps:
- name: Generate org-roam-ui page
uses: ikoamu/publish-org-roam-ui@main
with:
org-roam-db-filename: .db
deploy-to-pages: true
```
### Show Image
You can create an `img` directory directly under the repository and display image files stored there.
```org
[[./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
│ ├── roam2.org
│ └── ・・・
├── README.org
└── ・・・
```
### Setting site tile
You can change the title of the site by specifying `site-tile`. (The default is ORUI)
```yml
jobs:
main:
runs-on: ubuntu-latest
steps:
- name: Generate org-roam-ui page
uses: ikoamu/publish-org-roam-ui@main
with:
org-roam-db-filename: .db
site-title: my org-roam!
```
### Default section open
Sections can be kept closed during initial display.
```yml
jobs:
main:
runs-on: ubuntu-latest
steps:
- name: Generate org-roam-ui page
uses: ikoamu/publish-org-roam-ui@main
with:
org-roam-db-filename: .db
default-section-open: false
```
## 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.
### Search feature
Search by title, tags, or content and instantly open a node.
### 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]]
```
## 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 [email protected]:ikoamu/publish-org-roam-ui.git
cd publish-org-roam-ui
./local.sh /path/to/org-roam-dir .db
```