/LogSeq-GitHub_publish_graphs

Instruction on how to publish LogSeq Graphs automatically in Github

Primary LanguageHTML

alt text

Description

This repository provides comprehensive instructions for setting up and publishing your private LogSeq Graph as a shared site on your <owner>.github.io location using GitHub Actions.

Example:

If the <owner> is BestOwner and you have a private repository named LogBook containing a graph, this action will publish it under bestowner.github.io/LogBook.

How does it work?

When you push information into the private repository containing the LogSeq graph, an action will be triggered. This action will convert all public pages into your public website under a designated subfolder.

Setup

Configure LogSeq client to use GitHub

To set up your LogSeq Graph in GitHub, you need to use the Logseq-Git-Sync-101 repository.

Detailed instructions on how to accomplish this can be found in the Good and Geeky video tutorial.

Website - Configure your public Repository

This repository will host all your graphs as websites on <owner>.github.io.

  1. Create a site

    Follow the instructions to create your own .github.io website if you don't already have one.

  2. Create an access token

    The LogSeq Graph Repositories require an access token to publish to your site. It is recommended to use the new Fine-grained Tokens, but the classic tokens will also work since you will only be supplying them to a private repository.

  3. Set up an Index

    Since each graph has its own subfolder, there is no basic index file for the site. Browsing directly into a subfolder will result in a 404 error. However, accessing <owner>.github.io/LogSeq will work.

    To provide easy navigation, I have included an index.html file that can be placed in the root of your <owner>.github.io site. This file dynamically lists all the subfolders as buttons for accessing the graphs.

    Simply copy the github.io/index.html file into the root of your new <owner>.github.io site.

    This is a very simple index file that can be easily replaced with something better or customized for your personal use.

Graphs - Configure your private Repositories

The Graph repositories use the logseq/publish-spa solution to convert the Graph into a website using a modified action.

  1. Set up Token Authentication

    Before you can publish your LogSeq Graph in a remote repository, you need to provide the GitHub Action with an API secret called GH_TOKEN.

    • To create the GH_TOKEN, go to Settings>Secrets and variables>Action>Secrets (/settings/secrets/actions).
    • Name the secret GH_TOKEN and add the API access token created in Webiste step.

  2. Create GitHub Action

    Copy the file workflows/logseq-publisher.yaml to your new LogSeq repository under the folder .github/workflows/ in your graph's GitHub repository.

  3. Destination Change (optional)

    You can manually change the destination by adding the following variables under Settings>Secrets and variables>Action>Variables (/settings/variables/actions).

    • FOLDER
    • GITHUB_IO

    Example:

    FOLDER=LogGraph, GITHUB_IO=NextBestOwner, results in: 'nextbestowner.github.io/LogGraph'