UNDER DEVELOPMENT

DEVELOPER DOCS

API

You can deploy your website from other extensions to supplement other automations. The API to do so is shown below:

window.roamjs.extension.staticSite.deploy();

Github Action

A GitHub action for generating a static site from your Roam Graph is also available. You could use this for free to upload the generated files to your own hosting service. It uses the same underlying logic as the Static Site extension itself, querying the data by running a headless browser and logging into your account.

Inputs

  • roam_username - Required Your Roam username

  • roam_password - Required Your Roam password

  • roam_graph - Required Your Roam Graph

  • config_path - Optional The path to the json file use to override and Roam config settings, relative to the GITHUB_WORKSPACE environment variable. Default value is static_site.json.

Usage

uses: dvargas92495/roamjs-static-site@2022-01-22-00-07
with:
    roam_username: dvargas92495@gmail.com
    roam_password: ${{ secrets.ROAM_PASSWORD }}
    roam_graph: dvargas92495

I have an example repository showcasing this action. The resulting site is reachable at https://garden.davidvargas.me.