roam-garden / roam-export

A set of tools to Filter/transform/render RoamResearch JSON export. Used in Roam Garden

roam-export

Export filtering and processing library for https://roam.garden/

Installation

npm i roam-export

Usage

A basic usage is as follows:

import { RoamBlock, RoamJsonQuery, RoamPage } from "roam-export"
import { readFileSync } from "fs"

const data = readFileSync("path to json export", "utf8")
const allPages = JSON.parse(data) as Array<RoamPage>
  
const { pages, blockUids } = new RoamJsonQuery(allPages, 
  {makePagesWithTheseTagsPublic: ["make-public"], makeBlocksWithTheseTagsPrivate: []}).getPagesToRender()
  
// do something with pages

There are more tools for operating on Roam JSON available internally (see https://github.com/roam-garden/roam-export/blob/master/src/roam-utils.ts and https://github.com/roam-garden/roam-export/blob/master/src/filtering.ts)

roam-export's Issues

instructions for manual filtering of files

This looks amazing, it's exactly what I need to be able to filter pages
to make them plugin.
edit: to make them public. (accidental typo)

I saw you mentioning this in the gatsby digital garden issues

mathieudutour/gatsby-digital-garden#31

Would you mind elaborating a bit on the README on how to use this for the purposes of manually filtering files

Thanks a lot