From 9e50be053905a147949f9f7f2963d0d1e75e837f Mon Sep 17 00:00:00 2001 From: ikoamu Date: Sat, 16 Mar 2024 20:27:29 +0900 Subject: add example --- example/20240316194158-publish_org_roam_ui.org | 84 +++++++++++++++++++++++++ example/20240316194443-org_roam_ui.org | 10 +++ example/20240316194618-org_roam.org | 8 +++ example/20240316195927-roam.org | 9 +++ example/20240316200052-emacs.org | 9 +++ example/20240316200250-org_mode.org | 14 +++++ example/img/emacs-logo.png | Bin 0 -> 84690 bytes example/img/org-mode-unicorn.svg | 1 + example/img/workflow_result.png | Bin 0 -> 103251 bytes example/org-roam.db | Bin 0 -> 53248 bytes 10 files changed, 135 insertions(+) create mode 100644 example/20240316194158-publish_org_roam_ui.org create mode 100644 example/20240316194443-org_roam_ui.org create mode 100644 example/20240316194618-org_roam.org create mode 100644 example/20240316195927-roam.org create mode 100644 example/20240316200052-emacs.org create mode 100644 example/20240316200250-org_mode.org create mode 100644 example/img/emacs-logo.png create mode 100644 example/img/org-mode-unicorn.svg create mode 100644 example/img/workflow_result.png create mode 100644 example/org-roam.db (limited to 'example') diff --git a/example/20240316194158-publish_org_roam_ui.org b/example/20240316194158-publish_org_roam_ui.org new file mode 100644 index 0000000..2d07354 --- /dev/null +++ b/example/20240316194158-publish_org_roam_ui.org @@ -0,0 +1,84 @@ +:PROPERTIES: +:ID: 2FED95CA-A7BA-4960-8B9B-945E8BE21BF8 +:END: +#+title: publish-org-roam-ui +#+filetags: :github-actions:org-roam:emacs: + +https://github.com/marketplace/actions/publish-org-roam-ui + +* publish-org-roam-ui + +This action generates a static site for [[id:96C6CA60-33B3-4214-BCB8-9AC96A498852][org-roam-ui]] from [[id:2F076032-6C7E-45BB-8595-C4CE6CA3DD7B][org-roam]] files managed on GitHub. + +It also allows deployment to GitHub Pages. + +** How to Use +First, please manage the .org files in ~org-roam-directory~ and the db file in org-roam using git. + +#+begin_src elisp +(setq org-roam-directory "/path/to/org-roam-dir") +(setq org-roam-db-location "/path/to/org-roam-dir/.db") +#+end_src + +#+begin_src bash +cd /path/to/org-roam-dir/ +git init +#+end_src + +Then, a static org-roam-ui site is easily generated for the artifact by creating a workflow like the following. + +#+begin_src yaml +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: .db +#+end_src + +[[./img/workflow_result.png]] + +Deploy to GitHub Pages by setting ~deploy-to-pages~ to true. + +#+begin_src yaml +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: .db + deploy-to-pages: true +#+end_src + +*** Show Image + +You can create an ~img~ directory directly under the repository and display image files stored there. + +#+begin_src org +[[./img/test.png]] +#+end_src + +*** Setting site tile + +You can change the title of the site by specifying ~site-tile~. (The default is ORUI) + +#+begin_src yaml +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: .db + site-title: my org-roam! +#+end_src diff --git a/example/20240316194443-org_roam_ui.org b/example/20240316194443-org_roam_ui.org new file mode 100644 index 0000000..839ae8c --- /dev/null +++ b/example/20240316194443-org_roam_ui.org @@ -0,0 +1,10 @@ +:PROPERTIES: +:ID: 96C6CA60-33B3-4214-BCB8-9AC96A498852 +:END: +#+title: org-roam-ui +#+filetags: :org-roam: + +- Org-Roam-UI is a frontend for exploring and interacting with your [[id:2F076032-6C7E-45BB-8595-C4CE6CA3DD7B][org-roam]] notes. +- Org-Roam-UI is meant a successor of org-roam-server that extends functionality of org-roam with a Web app that runs side-by-side with [[id:66ECE52E-2723-41B3-A4AB-6CEC507C1349][Emacs]]. + + diff --git a/example/20240316194618-org_roam.org b/example/20240316194618-org_roam.org new file mode 100644 index 0000000..7c8fcb5 --- /dev/null +++ b/example/20240316194618-org_roam.org @@ -0,0 +1,8 @@ +:PROPERTIES: +:ID: 2F076032-6C7E-45BB-8595-C4CE6CA3DD7B +:END: +#+title: org-roam +#+filetags: :org-mode:org-roam:emacs: + +Org-roam is a plain-text knowledge management system. +It brings some of [[id:DD0EF7D6-E39E-4553-8FA4-945561F40238][roam]] more powerful features into the [[id:96FF21FB-FE8A-4BFF-B5D6-016CB391E24D][org-mode]] ecosystem. diff --git a/example/20240316195927-roam.org b/example/20240316195927-roam.org new file mode 100644 index 0000000..1c2bc12 --- /dev/null +++ b/example/20240316195927-roam.org @@ -0,0 +1,9 @@ +:PROPERTIES: +:ID: DD0EF7D6-E39E-4553-8FA4-945561F40238 +:END: +#+title: roam +#+filetags: :zettelkasten: + +https://roamresearch.com/ + +A note-taking tool for networked thought. diff --git a/example/20240316200052-emacs.org b/example/20240316200052-emacs.org new file mode 100644 index 0000000..66f7d0c --- /dev/null +++ b/example/20240316200052-emacs.org @@ -0,0 +1,9 @@ +:PROPERTIES: +:ID: 66ECE52E-2723-41B3-A4AB-6CEC507C1349 +:END: +#+title: Emacs +#+filetags: :emacs: + +[[./img/emacs-logo.png]] + +awesome text editor. diff --git a/example/20240316200250-org_mode.org b/example/20240316200250-org_mode.org new file mode 100644 index 0000000..dae1192 --- /dev/null +++ b/example/20240316200250-org_mode.org @@ -0,0 +1,14 @@ +:PROPERTIES: +:ID: 96FF21FB-FE8A-4BFF-B5D6-016CB391E24D +:ROAM_REFS: https://orgmode.org/ +:END: +#+title: org-mode + +[[./img/org-mode-unicorn.svg]] + +A GNU [[id:66ECE52E-2723-41B3-A4AB-6CEC507C1349][Emacs]] major mode for keeping notes, authoring documents, +computational notebooks, literate programming, maintaining to-do +lists, planning projects, and more — in a fast and effective plain +text system. + + diff --git a/example/img/emacs-logo.png b/example/img/emacs-logo.png new file mode 100644 index 0000000..8596657 Binary files /dev/null and b/example/img/emacs-logo.png differ diff --git a/example/img/org-mode-unicorn.svg b/example/img/org-mode-unicorn.svg new file mode 100644 index 0000000..2bbcae1 --- /dev/null +++ b/example/img/org-mode-unicorn.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/example/img/workflow_result.png b/example/img/workflow_result.png new file mode 100644 index 0000000..04b7508 Binary files /dev/null and b/example/img/workflow_result.png differ diff --git a/example/org-roam.db b/example/org-roam.db new file mode 100644 index 0000000..ec6be83 Binary files /dev/null and b/example/org-roam.db differ -- cgit