# assets

**Repository Path**: mirrors_jupyterlab/assets

## Basic Information

- **Project Name**: assets
- **Description**: Static assets for JupyterLab extensions
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-11-05
- **Last Updated**: 2026-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# JupyterLab static assets

This repository is serving static assets for JupyterLab in particular it is serving the Jupyter news feed.

## The news feed

### What is it?

The news feed allow to notify JupyterLab users directly within the application as seen in the below screencast:

![News in JupyterLab](https://user-images.githubusercontent.com/8435071/201953604-91e97e7c-4e89-4964-b9e4-cf488d7d0d6d.gif)

The news will be displayed as a toast only once. Then it will be only silently notified (accessible through the notification
center). And if the user dismiss the news, it will not see that news any longer.

### How does it works?

This repository builds a [GitHub pages website](https://docs.github.com/en/pages) that will be published at https://jupyterlab.github.io/assets/.

The website is using [Jekyll](https://jekyllrb.com/). And the news feed fetched by JupyterLab is generated by the plugin [jekyll-feed](https://github.com/jekyll/jekyll-feed/tree/v0.15.1); the Atom feed is accessible at https://jupyterlab.github.io/assets/feed.xml.

The feed plugin is parametrized to list only the most recent post (see the [configuration](./_config.yml)).

### How to draft a news?

To propose a news, you need to create a new PR that adds a new file in the folder [_posts](./_posts) named _YYYY-MM-DD-NAME-OF-POST.md_. You must replace _YYYY-MM-DD_ with the date of your post and _NAME-OF-POST_ with the name of your post.

The file itself must follow this structure:

```md
---
layout: post
title: "Thanks for using JupyterLab"
date: 2022-11-02 14:00:00 -0000
categories: posts
excerpt: "Big thanks to you, beloved JupyterLab user."
---

# Welcome

Thanks a lot for your interest in JupyterLab.
```

The header must contain the following entries:
- _layout_: Set to `post`
- _title_: Your post title
- _date_: The date and time for the post
- _categories_: Space separated list that must contains `posts`
- _excerpt_: Short summary of the post

The notification displayed in JupyterLab will be the concatenation of the _title_ and the _excerpt_ as plain text.

After the header, you can write the post using Markdown formatting.

> That part won't be displayed in JupyterLab but the notification will have a link to see it.

You will find additional information in the [GitHub documentation](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll#adding-a-new-post-to-your-site).

### How to publish a draft news?

Once you have open a draft news in a PR, it will require to be reviewed and approved
by at least 2 members of the JupyterLab council.

Once your PR is merged, the post will be the new one to be fetched by JupyterLab users.

> You can reach the council by opening a [discussion on GitHub](https://github.com/jupyterlab/team-compass/discussions).

### Security concerns

The notification message will be displayed as text content.