Skip to content

Commit b8d9885

Browse files
committed
docs: Update domain to www.springwolf.dev
Update README.md docs
1 parent 28bc2a4 commit b8d9885

File tree

4 files changed

+23
-16
lines changed

4 files changed

+23
-16
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
[![Deploy to GitHub Pages](https://github.com/springwolf/springwolf.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/springwolf/springwolf.github.io/actions/workflows/deploy.yml)
1+
# <img src="static/img/logo.png" alt="Logo" width="100"/> Springwolf Website
2+
[![Build](https://github.com/springwolf/springwolf.github.io/actions/workflows/build.yml/badge.svg)](https://github.com/springwolf/springwolf.github.io/actions/workflows/build.yml)
3+
[![Netlify Status](https://api.netlify.com/api/v1/badges/8dc370e2-1578-4a72-a729-747929a94400/deploy-status)](https://app.netlify.com/sites/springwolf/deploys)
24

3-
# Website
5+
Latest docs are deployed to
6+
- [https://www.springwolf.dev](https://www.springwolf.dev)
7+
- Backup: [https://springwolf.github.io](https://springwolf.github.io)
8+
9+
## Updating the website & documentation
410

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

7-
Latest docs are deployed to [https://springwolf.github.io](https://springwolf.github.io).
13+
The [docs](docs) folder contains all pages in Markdown format.
814

915
### Local Development
1016

17+
```bash
18+
npm start
1119
```
12-
$ npm start
13-
```
14-
15-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
16-
17-
### Deployment
1820

19-
1. Run `$ npm run build`.
20-
2. Run `$ npm run serve` to verify build was correct.
21-
3. Run `$ GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy`
21+
This command starts a local development server and opens up a browser window.
22+
Most changes are reflected live without having to restart the server.

docs/introduction.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ Springwolf is compliant to [AsyncAPI](https://www.asyncapi.com), which brings th
1414

1515
### Demo
1616

17-
You are welcome to take a look at a [live demo](https://springwolf.github.io/springwolf-ui/) of springwolf.
17+
View the [live demo](https://demo.springwolf.dev) of springwolf in action.
18+
19+
Also, the demos of the
20+
[amqp](https://amqp.demo.springwolf.dev),
21+
[cloud-stream](https://cloud-stream.demo.springwolf.dev),
22+
[kafka](https://kafka.demo.springwolf.dev)
23+
example projects are available.
1824

1925
![springwolf publishing demo](/img/demo.gif)
2026

docusaurus.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
88
const config = {
99
title: 'Springwolf',
1010
tagline: 'Automated documentation (and more) for async APIs built with Spring Boot',
11-
url: 'https://springwolf.github.io/',
11+
url: 'https://www.springwolf.dev/',
1212
baseUrl: '/',
1313
onBrokenLinks: 'throw',
1414
onBrokenMarkdownLinks: 'warn',
@@ -49,7 +49,7 @@ const config = {
4949
label: 'Documentation',
5050
},
5151
{
52-
href: 'https://springwolf.github.io/springwolf-ui/',
52+
href: 'https://demo.springwolf.dev',
5353
label: 'Demo',
5454
position: 'right',
5555
},

src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ function HomepageHeader() {
1717
<div className={styles.buttons}>
1818
<Link
1919
className="button button--secondary button--lg"
20-
to="https://springwolf.github.io/springwolf-ui/"
20+
to="https://demo.springwolf.dev/"
2121
target={"_blank"}>
2222
Live Demo
2323
</Link>

0 commit comments

Comments
 (0)