Publish your Logseq graph with a GitHub Action. ✨
This action is the missing piece for achieving a complete CD workflow for your public Logseq graph.
- It will load your graph and publish it into
www
(this is configurable) folder. - Next, you can then deploy
www
folder with JamesIves/github-pages-deploy-action.
- https://docs.logseq.com/
- https://note.xuanwo.io/
- https://pengx17.github.io/knowledge-garden/
- https://whatiknown.strrl.dev/
- https://io-oi.me/wiki/
A video walk through https://www.youtube.com/watch?v=UYqJcFEYUsY
Firstly, add this step to your Github workflow. You can refer to My Example Graph's workflows/main.yml as an example.
steps:
- uses: actions/checkout@v2
- name: Logseq Publish 🚩
uses: pengx17/logseq-publish@v0.1
- name: add a nojekyll file # to make sure asset paths are correctly identified
run: touch $GITHUB_WORKSPACE/www/.nojekyll
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@4.1.9
with:
branch: gh-pages # The branch the action should deploy to.
folder: www # The folder the action should deploy.
clean: true
Whenever you push changes to your Github repo, your graph will be published to the gh-pages
branch. A few minutes later, your GitHub Pages will get updated.
src
: Publish graph src directory. Defaults to `` (empty string, root repo directory).dest
: Publish destination directory. Defaults towww
.trace
: Whether or not to generate and publish trace file for debugging. This trace file will be uploaded as an artifact to the run. Defaults totrue
.
Here is a document about the story behind this action.
TLDR., this action will start Logseq desktop App in a Docker container, automate it by Playwright and finally load & publish the graph.
Since most of the work is done in a prepared Docker container, you can refer to action.yml and adapt it in other places without the need for GitHub actions.
Hint: you can checkout the trace file in the action artifacts and view it in the Playwright trace viewer to see what's going on in the action.
Kapture.2022-04-14.at.16.57.01.mp4
- One-liner Powershell call with only Docker installed as prerequisite. Below assumes that your folder workfolder has "KnowledgeGraph" for the graph, and "HTMLOutput" for the output. Container will be created and discarded on the fly.
PS C:\> docker run -d -i `
--name LogSeqPublishContainer `
--rm `
-v D:\WorfklowScripts\PublishLogseqExport\graph:/home/logseq/graph `
-w /home/logseq `
ghcr.io/pengx17/logseq-base:master `
bash -c "xvfb-run node /home/logseq/graph/publish.mjs -p /home/logseq/graph/KnowledgeGraph -t /home/logseq/graph/build_trace.txt -o /home/logseq/graph/HTMLOutput > /home/logseq/graph/build.log"
- clone https://github.com/logseq/logseq.git & https://github.com/pengx17/logseq-publish.git
- build logseq app
- cd into logseq src root
- change
"name": "Logseq"
inresources/package.json
to"name": "something-else"
- run
yarn
&&yarn release
- run
- copy logseq static into
logseq-publish/public/static
- in logseq-publish root, run
mkdir public
cp -r ../logseq/static ./public/static
(assuming logseq and logseq-publish is at the same folder)
- in logseq-publish root, run
- install logseq-publish deps
- makes sure you have
pnpm
& Node > 16 installed - run
pnpm i
- makes sure you have
- now you should be able to use
node publish.mjs
to run the script
Hints:
- use Playwright Debugging tools | Playwright to debug the script.
PWDEBUG=1 node publish.mjs