Skip to content

globus/example-data-portal-with-custom-content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Example : Serverless Data Portal with Custom Content

This repository is an example implementation of the @globus/template-data-portal.

You can create your own portal with similar functionality by following the Creating Your Own Research Data Portal section in the template repository and then referencing the sections below.

Creating a Custom Landing Page

  • Create a new file in your repository at /content/index.md and add your desired contents.
  • Commit your changes.
  • The template-included GitHub Action will automatically trigger rebuilding your site with the new landing page.

View Example: https://globus.github.io/example-data-portal-with-custom-content/ (Markdown Source)

Hosting Assets

  • Create a new directory /content/assets and add your desired assets.
  • Assets will be hosted at the root of your deployed application.
    • We recommend creating additional directories inside assets to avoid conflicts with other pages and general organization, e.g. /content/assets/images/...
  • When using Markdown, you can reference your assets using a full URL or relative path.
Asset Path Relative Reference Full URL
/content/assets/example.png ![](/example.png) ![](https://{username}.github.io/{repository_name}/example.png)
/content/assets/images/chart.jpg ![](/images/chart.jpg) ![](https://{username}.github.io/{repository_name}/images/chart.jpg)

View Example: https://globus.github.io/example-data-portal-with-custom-content/ (Markdown Source, Assets Source)

Additional Pages + Routes

The simplest way to add additional pages or routes to your portal is to create additional Markdown (.md) files in your content directory. When a new file is added, the page will become accessible at {HOST}/{CONTENT_RELATIVE_PATH_WITHOUT_EXTENSION}.

Content Path Page URL
/content/welcome.md {HOST}/welcome
/content/documentation/how-to.md {HOST}/documentation/how-to

View Example: https://globus.github.io/example-data-portal-with-custom-content/documentation/example (Markdown Source)