Orbit

Summary

  • id: dendron.orbit

The Orbit Import Pod can import all the members of an orbit workspace as an individual note of template People (Private).

Authorization

Orbit uses API tokens to authorize access to the API. You can find your API tokens on the Account Settings page.

The workspace slug can be fetched from the url. In the url provided below, dendron-hq is the workspace slug. https://app.orbit.love/dendron-hq

Example

  • config
vaultName: vault
token: ***
workspaceSlug: dendron-org

orbit member details

name: John Doe
twitter: johndoetwit
github: johndoegit
discord: johndoediscord

after import, a note with fname people.john-doe is created

id: test123
title: John Doe
desc: ''
social:
  linkedin: null
  twitter: johndoetwit
  discord: johndoediscord
  github: johndoegit
  hn: null
  website: null

Configuration

src

  • description: "Where to import from"
  • type: "string" as const
  • required: true

vaultName

  • description: "name of vault to import into"
  • type: "string" as const
  • required: true

concatenate

  • description: "whether to concatenate everything into one note"
  • type: "boolean"
  • default: false

When importing, you can either import everything from source as multiple files or concatenate it all together as one file

frontmatter

  • description: "frontmatter to add to each note"
  • type: "object"

You can add custom frontmatter to notes as you import them. This is useful for example, when you want to set custom publishing options for imported notes

fnameAsId

  • description: "use the file name as the id"
  • type: "boolean"

By default, random uuids are generated as the id for each imported note. This makes the id equivalent to that of the filename

destName

  • description: "If concatenate option is set, this is the name of the destination path
  • type: "string" as const

token

  • description: GitHub personal access token
  • type: string
  • required: true

workspaceSlug

  • description: slug of workspace to import from
  • type: string
  • required: true

Backlinks