open-index/open-npm huggingface dataset:
npm package: @rikclaessens/backstage-plugin-news
Description: The News plugin retrieves markdown files with frontmatter and displays them as news articles in Backstage, Spotify's IDP framework. This is the frontend plugin that offers a number of frontend components to renders news items.
Author: Rik Claessens
Latest version: 0.1.1

# backstage-plugin-news

To install the plugin in the Backstage app, run the following commands:

```bash
yarn --cwd packages/app add @rikclaessens/backstage-plugin-news
```

Then, make the plugin available in your Backstage instance by adding it to the `App.tsx`:

```tsx
...
import { NewsItemsPage } from '@rikclaessens/backstage-plugin-news';
...

const routes = (
  <FlatRoutes>
    ...
    <Route path="/news" element={<NewsItemsPage />} />
    ...
  </FlatRoutes>
);
...
```

When searching for news, Backstage provides a default search result item. The plugin provides a result item that shows more information to the user. To use this result item, add the following code to the `SearchPage.tsx`:

```tsx
import { NewsSearchResultListItem } from '@rikclaessens/backstage-plugin-news';
...

<SearchResult>
  ...
  <NewsSearchResultListItem icon={<Bullhorn />} />
</SearchResult>
...
```
npm package: @rikclaessens/backstage-plugin-news-backend
Description: The News plugin retrieves markdown files with frontmatter and displays them as news articles in Backstage, Spotify's IDP framework. This is the backend plugin that retrieves news items, stores them in the database and make them available through the api.
Author: Rik Claessens
Latest version: 0.1.4

# @rikclaessens/backstage-plugin-news-backend

The News plugin retrieves markdown files with frontmatter and displays them as news articles in Backstage, Spotify's IDP framework. This is the backend plugin that retrieves news items, stores them in the database and make them available through the api.

## Installation

To install this plugin to your backend package, run the following command:

```bash
# From your root directory
yarn --cwd packages/backend add @rikclaessens/backstage-plugin-news-backend
```

Then add the plugin to your backend in `packages/backend/src/index.ts`:

```ts
const backend = createBackend();
// ...
backend.add(import('@rikclaessens/backstage-plugin-news-backend'));
```

To configure the locations of the news articles, add the following to your app's `app-config.yaml`:

```yaml
news:
  locations:
    - https://dev.azure.com/your-org/your-project/_git/your-news-repo
```

## Writing content

You can add `.md` files to the configured locations. The files should have a frontmatter section at the top of the file. The frontmatter should contain the following fields:
- `title`: The title of the news item
- `summary`: A short summary of the news item
- `created_at`: The date the news item was created in the format `YYYY-MM-DD`
- `author`: The author of the news item, backstage ref
- `status`: The status of the news item, one of `draft`, `published`
- `tags`: An array of tags for the news item

An example of a news item markdown file:

```md
---
title: Backstage is the best way to create an IDP
summary: Using Spotify's Backstage framework to create an IDP for your company is the best way to go. You leverage a wide community of developers and a robust framework to build your IDP.
created_at: 2025-03-13
author: my-awesome-team
status: published
tags: [artificial-intelligence, software-development]
---


# Title

more markdown content here
```

For now, relative urls for images are not supported. Use absolute urls instead.

## Development

This plugin backend can be started in a standalone mode from directly in this
package with `yarn start`. It is a limited setup that is most convenient when
developing the plugin backend itself.
npm package: @rikclaessens/backstage-plugin-search-backend-module-news
Description: The news backend module for the search plugin.
Latest version: 0.1.2

# @rikclaessens/backstage-plugin-search-backend-module-news

The News plugin retrieves markdown files with frontmatter and displays them as news articles in Backstage, Spotify's IDP framework. This is the search backend module that retrieves news items stored in the database and indexes them in the configured search service.

## Installation

To install this plugin to your backend package, run the following command:

```bash
# From your root directory
yarn --cwd packages/backend add @rikclaessens/backstage-plugin-search-backend-module-news
```

Then add the plugin to your backend in `packages/backend/src/index.ts`:

```ts
const backend = createBackend();
// ...
backend.add(import('@rikclaessens/backstage-plugin-search-backend-module-news'));
```