RoamResearch Discourse Graph Extension
  • 🏠Welcome!
  • πŸ‘·β€β™€οΈInstallation
  • πŸ—ΊοΈGuides
    • Creating discourse nodes
    • Creating discourse relationships
    • Exploring your discourse graph
      • Discourse context
      • Discourse context overlay
      • Discourse attributes
      • Node index
    • Querying your discourse graph
    • Extending and personalizing your discourse graph
    • Sharing your discourse graph
  • 🧱Fundamentals
    • What is a Discourse Graph?
    • The Base Grammar: Questions, Claims, and Evidence
    • The Discourse Graph Extension Grammar
      • Nodes
      • Operators and relations
      • Relation patterns
      • Specifying context for discourse relations
    • Graph Querying
  • 🚒Use Cases
    • Individual literature reviewing
    • Enhanced zettelkasten
    • Enhanced reading clubs/seminars
    • Open-science-ready lab notebooks
    • Grounded product / research roadmapping
  • Extras
    • Experimental features
      • Playground
    • Keyboard Shortcuts
    • CSS
  • Meta
    • πŸ”¬This is research software!
    • πŸš€Changelog
    • πŸ™‹Getting support
Powered by GitBook
On this page
  1. Guides

Sharing your discourse graph

PreviousExtending and personalizing your discourse graphNextWhat is a Discourse Graph?

Last updated 2 years ago

You can export your discourse graph as a whole, or from queries of your graph, to archive your most important notes, or share them with others.

The extension exports to 1) markdown, 2) csv (neo4j-compatible ), and 3) json

Demo:

Markdown export options

Since markdown has different flavors, and different tools you might want to export/archive your notes to handle links differently (e.g., wikilinks vs. markdown links) and different operating systems have different filename limitations, we have a range of options for customizing the markdown export. These can be found on the Export tab of the discourse graph configuration in roam/js/discourse-graph.

Here is a brief explanation of each option:

  • Max Filename Length sets the maximum length of the filenames; this is important if you have page names that are quite long and may run afoul of, say, Windows' filename length limit of 250-260 characters.

  • Remove Special Characters removes all "special characters" that may lead to trouble for filenames in different operating systems, such as ? (not allowed on Windows) or / (denotes file/folder boundaries).

  • Simplified Filename strips away all "template" characters (i.e., everything except the {content} in the node format: for example, if you define a Claim node as [[CLM]] - {content}, and have a Claim node [[[[CLM]] - people are lazy]], the exported filename will be people are lazy

  • Frontmatter specifies what properties to add to the YAML.

    • By default, the properties are:

      • title: {text}

      • author: {author}

      • date: {date}

    • You can add properties as key-value pairs in the same format:

  • Resolve Block References and Resolve Block Embeds control whether you want to resolve block references/embeds in your export. You can keep this turned off if you are unsure of the privacy implications of references/embeds.

  • Link Type controls whether inline page references are wikilinks ([[like this]]) or alias ([like this](pageName.md))

url:

Here is an example of a discourse graph exported to Obsidian-compatible markdown:

πŸ—ΊοΈ
https://roamresearch.com/#/app/yourGraphName/page/{uid}
https://publish.obsidian.md/joelchan-notes
labeled property graph