Skip to content

Commit

Permalink
Add badges to doc and site (interTwin-eu#295)
Browse files Browse the repository at this point in the history
* badges on readme

Signed-off-by: Diego Ciangottini <[email protected]>
  • Loading branch information
dciangot committed Nov 13, 2024
1 parent e3b566f commit 4061454
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
![GitHub License](https://img.shields.io/github/license/intertwin-eu/interlink)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/intertwin-eu/interlink/total)
![GitHub Repo stars](https://img.shields.io/github/stars/intertwin-eu/interlink)

![GitHub Release](https://img.shields.io/github/v/release/intertwin-eu/interlink)
![Tested with Dagger](https://img.shields.io/badge/tested_with_dagger-v0.13.3-green)

![Home Page](https://img.shields.io/badge/home_page-orange?link=https%3A%2F%2Fintertwin-eu.github.io%2Ft%2FinterLink%2F)
![Slack server](https://img.shields.io/badge/slack_server-8A2BE2?link=https%3A%2F%2Fjoin.slack.com%2Ft%2Fintertwin%2Fshared_invite%2Fzt-2cs67h9wz-2DFQ6EiSQGS1vlbbbJHctA)

![Interlink logo](./docs/static/img/interlink_logo.png)

## :information_source: Overview
Expand Down
7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Dagger module to site preview

```bash
dagger -m github.com/levlaz/daggerverse/docusaurus@f073c72e0a7345bba2173a15269307df297c3c13 call \ (⎈|default:default)
--src ./ serve up
```

### Installation

```
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

# Introduction

![GitHub License](https://img.shields.io/github/license/intertwin-eu/interlink)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/intertwin-eu/interlink/total)
![GitHub Repo stars](https://img.shields.io/github/stars/intertwin-eu/interlink)

![GitHub Release](https://img.shields.io/github/v/release/intertwin-eu/interlink)
![Tested with Dagger](https://img.shields.io/badge/tested_with_dagger-v0.13.3-green)

![Slack server](https://img.shields.io/badge/slack_server-8A2BE2?link=https%3A%2F%2Fjoin.slack.com%2Ft%2Fintertwin%2Fshared_invite%2Fzt-2cs67h9wz-2DFQ6EiSQGS1vlbbbJHctA)

:::warning

interLink is in early development phase, thus subject to breaking changes with no guarantee of backward compatibility.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ function HomepageHeader() {
}}
/>
</Heading>

<Heading as="h2" className="hero__title">
{siteConfig.tagline}
</Heading>
Expand All @@ -38,6 +39,10 @@ function HomepageHeader() {
</Link>

</div>
<img alt="Stars" src="https://img.shields.io/github/stars/intertwin-eu/interlink" style={{ marginTop: '1rem' }}/>
<br/>
<img alt="Slack" src="https://img.shields.io/badge/Join_Slack_Server!-8A2BE2?link=https%3A%2F%2Fjoin.slack.com%2Ft%2Fintertwin%2Fshared_invite%2Fzt-2cs67h9wz-2DFQ6EiSQGS1vlbbbJHctA"/>
<HomepageFeatures />
<HomepageFeatures />
</div>
</header>
Expand Down

0 comments on commit 4061454

Please sign in to comment.