PLUGINS

Table of Contents


Plugins

This extension comes with its own set of plugins that you could add on to your website. Plugins are common website elements that help bring the website to life. Browse through the available plugins to see if there are any that you would like to add to your website!

Footer

The footer plugin adds a standardized footer to the bottom of every page on your website. It comes with a copyright label, a "Built with RoamJS" attribution, and social media links laid out left to right respectively. The plugin supports the following options:

  • links - Urls to social media links. Supported platforms will automatically convert to the related icon.

  • copyright - The label used for the copyright that the website is owned by.

Header

The header plugin adds a standardized header to the top of every page on your website. It comes with a link to your home page, links for easy navigation, and an optional right icon laid out left to right respectively. The plugin supports the following options:

  • links - Page links to other pages in your website. Could use page references directly or just the name of the page.

  • home - The icon used to navigate home. Supports both raw text or an image.

  • right icon - An icon to include on the top right corner of the page. If used, the page links will be centered instead of right justified.

Image Preview

The image preview plugin turns all images that were in Roam blocks preview-able in the same way as they were in Roam. Simply click on the image to enlarge it full screen and click outside the image to exit. To opt any image out from being previewable, give the block it's in a #.roamjs-image-preview-ignore tag.

Paths

The paths plugin provides different options for specifying the names of all of your URL paths. By default, the extension uses the name of the page as the URL. This extension uses the type option to provide the following options:

  • uid - Use the page's id from Roam as the path

  • lowercase - Use the page's title in all lowercase as the path

Sidebar

The sidebar plugin adds a static sidebar to the right of the page that could host different widgets of information. The plugin supports the following options:

  • widgets - The different widgets to include in the sidebar. Options:

    • graph - A graph view of your linked references.