Skip to content

Commit

Permalink
Replace Gatsby with Docusaurus. (#211)
Browse files Browse the repository at this point in the history
* Replace Gatsby with Docusaurus.

Gatsby is great, but brings a high level of complexity, and in this
commit, it is replaced with Docusaurus which is simpler and also
streamlined to produced versioned documentation. Things like a
collapsable sidebar, right hand side page navigation, bread-crumbs,
warning about using old site documentation, just works out of the box.

Themes (light and dark) has also been added along with a search-bar
which is backed by Google's programmable search engine.

Lots of unused images were removed.

Signed-off-by: Thomas Hallgren <[email protected]>
  • Loading branch information
thallgren authored Sep 30, 2024
1 parent 8ac60d8 commit 7386895
Show file tree
Hide file tree
Showing 567 changed files with 7,662 additions and 27,086 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/blc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ jobs:
with:
repository: datawire/getambassador.io-blc2
path: blc
- run: yarn install
- run: yarn
working-directory: site
- run: yarn run gatsby build
- run: yarn build
working-directory: site
- run: npm install
working-directory: blc
Expand All @@ -24,7 +24,7 @@ jobs:
set -o pipefail
(TARGET=../site PRODUCT=telepresenceio make -C . > blc.log) || ! (grep 'has a broken' blc.log)
working-directory: blc
- uses: actions/upload-artifact@v2
- uses: actions/upload-artifact@v4
with:
name: blc.log
path: blc/blc.log
Expand Down
7 changes: 3 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ jobs:
steps:
- uses: actions/setup-node@v4
- uses: actions/checkout@v4
- run: yarn install
- name: "yarn run gatsby build"
- run: yarn
- name: "yarn build"
run: |
# The sed part of this command removes terminal escape codes.
NODE_ENV=development yarn run gatsby build
yarn build
- name: "Dirty check"
run: |
git add .
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
/.cache/
/public/

# Docusaurus
/.docusaurus/
/build/

# gatsby-plugin-extract-schema
/schema.graphql

Expand Down
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

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

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
135 changes: 0 additions & 135 deletions bin/serve.js

This file was deleted.

135 changes: 0 additions & 135 deletions docs-config.js

This file was deleted.

Empty file added docs/dummy.md
Empty file.
1 change: 0 additions & 1 deletion docs/latest

This file was deleted.

Loading

0 comments on commit 7386895

Please sign in to comment.