https://github.com/globus/example-data-portal-with-custom-content
An example data portal that includes custom Markdown and MDX content.
https://github.com/globus/example-data-portal-with-custom-content
example portal serverless
Last synced: 6 days ago
JSON representation
An example data portal that includes custom Markdown and MDX content.
- Host: GitHub
- URL: https://github.com/globus/example-data-portal-with-custom-content
- Owner: globus
- Created: 2024-10-30T17:50:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-12T15:24:30.000Z (20 days ago)
- Last Synced: 2026-01-12T21:36:04.042Z (19 days ago)
- Topics: example, portal, serverless
- Homepage: https://globus.github.io/example-data-portal-with-custom-content/
- Size: 23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example : Serverless Data Portal with Custom Content
This repository is an example implementation of the [@globus/template-data-portal](https://github.com/globus/template-data-portal).
You can create your own portal with similar functionality by following the [**Creating Your Own Research Data Portal**](https://github.com/globus/template-data-portal?tab=readme-ov-file#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.
- The underlying portal code supports [CommonMark](https://commonmark.org/).
- 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](/content/index.md))
## 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` | `` | `` |
| `/content/assets/images/chart.jpg` | `` | `` |
View Example: https://globus.github.io/example-data-portal-with-custom-content/ ([Markdown Source](/content/index.md), [Assets Source](/content/assets))
## 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](/content/documentation/example.md))