Skip to content

A docker image and action to publish org-mode files to html

License

Notifications You must be signed in to change notification settings

maker2413/OrgPublish

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OrgPublish

This repo provides a GitHub action to allow you to publish org-roam files to html files. I use this action to publish my org-roam notes to my website: https://notes.ethancpost.com.

This repo builds a docker image to publish org files to html. This docker image is built off of alpine:latest to keep it as small and minimal as possible.

Action Parameters

This action has the following inputs that can be configured:

publish_script
used to specify a custom elisp publish script.

Usage

name: Publish
on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-latest

  steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: Publish Org Files
      uses: maker2413/[email protected]

Running Docker Image

You can also run this docker image without utilizing the action. This can be useful for local publishing outside of GitHub actions or for developing a custom elisp script for publishing. To run this docker image to publish your org-roam files to html you just have to run the following command:

docker run -v <org-roam directory>:/opt/OrgFiles maker2413/orgroampublish

You can also run your own custom publish script by simply providing it as an argument to this command:

docker run -v <org-roam directory>:/opt/OrgFiles maker2413/orgroampublish <custom.el>