Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
zap

GitHub Action

Publish org-roam-ui

v1.0.0

Publish org-roam-ui

zap

Publish org-roam-ui

Generate org-roam-ui static page and deploy to GitHub Pages

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Publish org-roam-ui

              
  uses: ikoamu/publish-org-roam-ui@v1.0.0
Learn more about this action in ikoamu/publish-org-roam-ui

Choose a version

publish-org-roam-ui

This action generates a static site for org-roam-ui from org-roam files managed on GitHub.

It also allows deployment to GitHub Pages. (See https://ikoamu.github.io/publish-org-roam-ui/)

How to Use

First, please manage the .org files in org-roam-directory and the db file in org-roam using git.

(setq org-roam-directory "/path/to/org-roam-dir")
(setq org-roam-db-location "/path/to/org-roam-dir/<org-roam-filename>.db")
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.

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/org-roam-ui-hosting@main
        with:
          org-roam-db-filename: <org-roam-filename>.db
generated artifact

Deploy to GitHub Pages by setting deploy-to-pages to true.

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Generate org-roam-ui page
        uses: ikoamu/org-roam-ui-hosting@main
        with:
          org-roam-db-filename: <org-roam-filename>.db
          deploy-to-pages: true

Show Image

You can create an img directory directly under the repository and display image files stored there.

[[./img/test.png]]

Setting site tile

You can change the title of the site by specifying site-tile. (The default is ORUI)

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Generate org-roam-ui page
        uses: ikoamu/org-roam-ui-hosting@main
        with:
          org-roam-db-filename: <org-roam-filename>.db
          site-title: my org-roam!