Skip to content

Commit 23486cf

Browse files
authored
Switch to docusaurus (#21)
1 parent 5112879 commit 23486cf

File tree

18 files changed

+16976
-371
lines changed

18 files changed

+16976
-371
lines changed

.github/workflows/pages.yml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy Jekyll site to Pages
1+
name: Deploy Docusaurus site to Pages
22

33
on:
44
push:
@@ -21,15 +21,21 @@ jobs:
2121
steps:
2222
- name: Checkout
2323
uses: actions/checkout@v4
24+
- name: Setup Node.js
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: '20'
28+
cache: npm
29+
- name: Install dependencies
30+
run: npm ci
31+
- name: Build
32+
run: npm run build
2433
- name: Setup Pages
2534
uses: actions/configure-pages@v5
26-
- name: Build with Jekyll
27-
uses: actions/jekyll-build-pages@v1
28-
with:
29-
source: ./docs/
30-
destination: ./_site
3135
- name: Upload artifact
3236
uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: build
3339

3440
# Deployment job
3541
deploy:

.gitignore

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
1-
_site/
2-
.sass-cache/
3-
.jekyll-cache/
4-
.jekyll-metadata
5-
# Ignore folders generated by Bundler
6-
.bundle/
7-
vendor/
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
*.js
11+
!src/**/*.js
12+
13+
# Misc
14+
.DS_Store
15+
.env.local
16+
.env.development.local
17+
.env.test.local
18+
.env.production.local
19+
20+
npm-debug.log*
21+
yarn-debug.log*
22+
yarn-error.log*

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
11
# Roo Code Docs
22

3-
## Prerequisites
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
44

5-
Before running the documentation locally, ensure you have:
6-
- Ruby installed (2.5.0 or higher recommended)
7-
- Bundler gem installed (`gem install bundler`)
5+
### Installation
86

9-
## Local Development
7+
```
8+
$ yarn
9+
```
1010

11-
To build and serve the documentation locally:
11+
### Local Development
1212

13-
```bash
14-
rake serve
13+
```
14+
$ yarn start
1515
```
1616

17-
The documentation will be available at http://127.0.0.1:4000
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1818

19-
## Contributing
19+
### Build
2020

21-
We love community contributions! Here's how to get involved:
21+
```
22+
$ yarn build
23+
```
2224

23-
1. Check Issues & Requests: See open issues or feature requests.
24-
2. Fork & branch off main.
25-
3. Submit a Pull Request once your documentation feature or fix is ready.
26-
4. Join our Reddit community and Discord for feedback, tips, and announcements.
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.

docs/Gemfile

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

0 commit comments

Comments
 (0)