Skip to content

Commit a099a14

Browse files
authored
Switch to docusaurus (#4)
1 parent 8d5b7ad commit a099a14

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+10847
-492
lines changed

.github/workflows/deploy.yaml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
build:
12+
name: Build Docusaurus
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: 18
21+
cache: yarn
22+
23+
- name: Install dependencies
24+
run: yarn install --frozen-lockfile
25+
- name: Build website
26+
run: yarn build
27+
28+
- name: Upload Build Artifact
29+
uses: actions/upload-pages-artifact@v3
30+
with:
31+
path: build
32+
33+
deploy:
34+
name: Deploy to GitHub Pages
35+
needs: build
36+
37+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
38+
permissions:
39+
pages: write # to deploy to Pages
40+
id-token: write # to verify the deployment originates from an appropriate source
41+
42+
# Deploy to the github-pages environment
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

.github/workflows/main.yml

Lines changed: 0 additions & 31 deletions
This file was deleted.

.github/workflows/test-deploy.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Test deployment
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
test-deploy:
12+
name: Test deployment
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: 18
21+
cache: yarn
22+
23+
- name: Install dependencies
24+
run: yarn install --frozen-lockfile
25+
- name: Test build website
26+
run: yarn build

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
11
public/
2+
node_modules/
3+
.DS_Store
4+
build/
5+
.docusaurus
6+

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,30 @@
22

33
This is the website for the Rust GPU organization.
44

5-
## Building
6-
1. Install [zola](https://www.getzola.org/)
7-
2. `git submodule update --init --recursive`
8-
3. `zola build`
5+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
6+
7+
### Installation
8+
9+
```
10+
$ yarn
11+
```
12+
13+
### Local Development
14+
15+
```
16+
$ yarn start
17+
```
18+
19+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
20+
21+
### Build
22+
23+
```
24+
$ yarn build
25+
```
26+
27+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
28+
29+
### Deployment
30+
31+
Auto deployed to GitHub pages via GitHub Actions.

babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

content/blog/2024-08-12-transition-announcement.md renamed to blog/2024-08-12-transition-announcement.md

Lines changed: 22 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
+++
2-
title = "Rust GPU Transitions to Community Ownership"
3-
authors = ["LegNeato", "eddyb"]
4-
+++
1+
---
2+
title: "Rust GPU Transitions to Community Ownership"
3+
authors: ["LegNeato", "eddyb"]
4+
slug: transition-announcement
5+
tags: ["announcement"]
6+
---
57

68
We are excited to announce that as of today the <a
79
href="https://rust-gpu.github.io">Rust GPU</a> project will be transitioning from
@@ -11,6 +13,8 @@ beginning of a broader strategy aimed at revitalizing, unifying, and standardizi
1113
programming in Rust. We are eager to share more details in the near future but in the
1214
meantime if you are a maintainer of a GPU-related Rust project, please reach out!
1315

16+
<!-- truncate -->
17+
1418
## What is Rust GPU?
1519

1620
<a href="https://rust-gpu.github.io">Rust GPU</a> makes it possible to write and run GPU
@@ -29,35 +33,20 @@ and possibly integrated with Rust GPU.
2933

3034
To put Rust GPU in context, here's an overview of the current landscape:
3135

32-
- [rust-gpu](https://github.com/EmbarkStudios/rust-gpu): Compiles unmodified Rust code to
33-
[SPIR-V](https://www.khronos.org/spir/) (Vulkan) so that it can run on the GPU.
34-
- [rust-cuda](https://github.com/Rust-GPU/Rust-CUDA): Compiles unmodified Rust code to
35-
[NVVM](https://docs.nvidia.com/cuda/nvvm-ir-spec/index.html) (CUDA) so that it can run
36-
on the GPU. _Currently unmaintained but stay tuned!_
37-
- [nvptx backend in
38-
rustc](https://doc.rust-lang.org/rustc/platform-support/nvptx64-nvidia-cuda.html):
39-
Compiles unmodified Rust code to
40-
[PTX](https://docs.nvidia.com/cuda/parallel-thread-execution/index.html) (CUDA) so
41-
that it can run on the GPU.
42-
- [CubeCL](https://github.com/tracel-ai/cubecl): Compute language extension for Rust.
43-
Enables annotated Rust code to run on the GPU.
44-
- [krnl](https://github.com/charles-r-earp/krnl): Safe, portable, high performance
45-
compute (GPGPU) kernels. Enables annotated Rust code to run on the GPU (via Rust GPU).
46-
- [cudarc](https://github.com/coreylowman/cudarc): Minimal and safe api over the CUDA
47-
toolkit. Enables calling CUDA from Rust running on the CPU.
48-
- [wgpu](https://wgpu.rs/): A safe and portable graphics library for Rust based on the
49-
WebGPU API. Enables communicating with the GPU from Rust running on the CPU.
50-
- [naga](https://github.com/gfx-rs/wgpu/tree/trunk/naga): A source code translator
51-
written in Rust that converts between various GPU-specific shader languages
52-
([WGSL](https://www.w3.org/TR/WGSL/),
53-
[GLSL](https://en.wikipedia.org/wiki/OpenGL_Shading_Language),
54-
[HLSL](https://en.wikipedia.org/wiki/High-Level_Shader_Language), and
55-
[MSL](https://developer.apple.com/metal/)). These shaders ultimately run on the GPU.
56-
- [ZLUDA](https://github.com/vosen/ZLUDA): A drop-in replacement for CUDA written in
57-
Rust. Enables using tools and libraries targeted at CUDA on non-NVIDIA hardware.
58-
- [Asahi Linux GPU
59-
drivers](https://asahilinux.org/2022/12/gpu-drivers-now-in-asahi-linux/): GPU drivers
60-
partially written in Rust to add Linux support for Apple GPUs.
36+
- **[rust-gpu](https://github.com/EmbarkStudios/rust-gpu)**: Compiles unmodified Rust
37+
code to [SPIR-V](https://www.khronos.org/spir/) (Vulkan) so that it can run on the
38+
GPU.
39+
- **[rust-cuda](https://github.com/Rust-GPU/Rust-CUDA)**: Compiles unmodified Rust code
40+
to [NVVM](https://docs.nvidia.com/cuda/nvvm-ir-spec/index.html) (CUDA) so that it can
41+
run on the GPU. _Currently unmaintained but stay tuned!_
42+
- **[nvptx backend in rustc](https://doc.rust-lang.org/rustc/platform-support/nvptx64-nvidia-cuda.html)**: Compiles unmodified Rust code to [PTX](https://docs.nvidia.com/cuda/parallel-thread-execution/index.html) (CUDA) so that it can run on the GPU.
43+
- **[CubeCL](https://github.com/tracel-ai/cubecl)**: Compute language extension for Rust. Enables annotated Rust code to run on the GPU.
44+
- **[krnl](https://github.com/charles-r-earp/krnl)**: Safe, portable, high performance compute (GPGPU) kernels. Enables annotated Rust code to run on the GPU (via Rust GPU).
45+
- **[cudarc](https://github.com/coreylowman/cudarc)**: Minimal and safe api over the CUDA toolkit. Enables calling CUDA from Rust running on the CPU.
46+
- **[wgpu](https://wgpu.rs/)**: A safe and portable graphics library for Rust based on the WebGPU API. Enables communicating with the GPU from Rust running on the CPU.
47+
- **[naga](https://github.com/gfx-rs/wgpu/tree/trunk/naga)**: A source code translator written in Rust that converts between various GPU-specific shader languages ([WGSL](https://www.w3.org/TR/WGSL/)**, **[GLSL](https://en.wikipedia.org/wiki/OpenGL_Shading_Language), [HLSL](https://en.wikipedia.org/wiki/High-Level_Shader_Language), and [MSL](https://developer.apple.com/metal/)). These shaders ultimately run on the GPU.
48+
- **[ZLUDA](https://github.com/vosen/ZLUDA)**: A drop-in replacement for CUDA written in Rust. Enables using tools and libraries targeted at CUDA on non-NVIDIA hardware.
49+
- **[Asahi Linux GPU drivers](https://asahilinux.org/2022/12/gpu-drivers-now-in-asahi-linux/)**: GPU drivers partially written in Rust to add Linux support for Apple GPUs.
6150

6251
## Why Rust for GPU Programming?
6352

@@ -200,8 +189,3 @@ Thank you for your continued support and contributions. Stay tuned for more upda
200189
don't hesitate to reach out if you have any questions or want to get involved.
201190

202191
Happy coding!
203-
204-
_LegNeato ([GitHub](https://github.com/LegNeato),
205-
[Twitter](https://twitter.com/legneato)) and eddyb ([GitHub](https://github.com/eddyb))_
206-
207-
**Rust GPU Maintainers**

blog/authors.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
LegNeato:
2+
name: Christian Legnitto
3+
title: Rust GPU maintainer
4+
url: https://github.com/LegNeato
5+
image_url:
6+
## Image URL managed by the fetchAuthorImages plugin. Changes may be overwritten.
7+
/img/authors/LegNeato.png
8+
socials:
9+
x: LegNeato
10+
github: LegNeato
11+
12+
eddyb:
13+
name: EddyB
14+
title: Rust GPU maintainer
15+
image_url:
16+
## Image URL managed by the fetchAuthorImages plugin. Changes may be overwritten.
17+
/img/authors/eddyb.png
18+
socials:
19+
github: eddyb

blog/tags.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
release:
2+
label: release
3+
permalink: /releases
4+
description: New releases
5+
6+
announcement:
7+
label: announcement
8+
permalink: /announcements
9+
description: Announcements
10+
11+
demo:
12+
label: demo
13+
permalink: /demos
14+
description: Demos

config.toml

Lines changed: 0 additions & 31 deletions
This file was deleted.

content/_index.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

0 commit comments

Comments
 (0)