Skip to content

Commit 4fb810b

Browse files
committed
Improve website
1 parent 152d6a3 commit 4fb810b

File tree

27 files changed

+687
-339
lines changed

27 files changed

+687
-339
lines changed

.github/workflows/deploy.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Deploy
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
strategy:
21+
matrix:
22+
node-version: [22.x]
23+
steps:
24+
- uses: actions/checkout@v4
25+
- name: Use Node.js ${{ matrix.node-version }}
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: ${{ matrix.node-version }}
29+
- name: Setup Pages
30+
uses: actions/configure-pages@v5
31+
- name: Install modules
32+
run: npm i
33+
- name: Test
34+
run: npm test
35+
- name: Build
36+
run: npm run build
37+
- name: Upload artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: "out"
41+
- name: Deploy to GitHub Pages
42+
id: deployment
43+
uses: actions/deploy-pages@v4

.github/workflows/test.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Test
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
branches: [ "main" ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
node-version: [22.x]
15+
steps:
16+
- uses: actions/checkout@v4
17+
- name: Use Node.js ${{ matrix.node-version }}
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: ${{ matrix.node-version }}
21+
- run: npm i
22+
- run: npm test

.gitignore

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/node_modules
2+
.source
3+
/coverage
4+
/.next/
5+
/out/
6+
/build
7+
*.tsbuildinfo
8+
.DS_Store
9+
*.pem
10+
/.pnp
11+
.pnp.js
12+
npm-debug.log*
13+
yarn-debug.log*
14+
yarn-error.log*
15+
.env*.local
16+
.vercel
17+
next-env.d.ts
18+
package-lock.json

content/docs/getting-started.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Getting Started
3+
description: How to get started on your first OS.
4+
---
5+
6+
Welcome! Let's start by installing `os-compiler`, which will be referenced later as just *compiler*.
7+
Compiler is required for you to easily compile your OS and apps source code, add kernel and all the needed libraries, and make the final binaries.
8+
9+
Start by downloading latest [os-compiler](https://github.com/CatCoreV/os-compiler) release from **GitHub** either manually or via terminal:
10+
```bash
11+
topcatto@CAT-PC:~ $ git clone --branch v0.0.1 https://github.com/CatCoreV/os-compiler.git
12+
```
13+
14+
After that, enter `os-compiler` folder and run install script depending on your host OS.
15+
16+
```bash
17+
topcatto@CAT-PC:~ $ cd os-compiler
18+
```
19+
20+
```bash
21+
# Windows
22+
D:\os-compiler> .\install-windows
23+
24+
# Linux / MacOS
25+
topcatto@CAT-PC:~/os-compiler $ chmod +x install-unix.sh && ./install-unix.sh
26+
```
27+
28+
Now, just open `catcore_compiler` / `catcore_compiler.exe` / `Catcore Compiler` depending on your host OS.

eslint.config.mjs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import { defineConfig, globalIgnores } from "eslint/config";
2+
import nextVitals from "eslint-config-next/core-web-vitals";
3+
4+
const eslintConfig = defineConfig([
5+
...nextVitals,
6+
globalIgnores([ ".next/**", "out/**", "build/**", "next-env.d.ts", ".source/**" ])
7+
]);
8+
9+
export default eslintConfig;

index.html

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

next.config.mjs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { createMDX } from "fumadocs-mdx/next";
2+
3+
const withMDX = createMDX();
4+
5+
/** @type {import("next").NextConfig} */
6+
const config = {
7+
"reactStrictMode": true,
8+
"output": "export"
9+
};
10+
11+
export default withMDX(config);

package.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"name": "catcore-website",
3+
"version": "0.0.1",
4+
"private": true,
5+
"scripts": {
6+
"build": "next build",
7+
"dev": "next dev",
8+
"start": "next start",
9+
"types:check": "fumadocs-mdx && next typegen && tsc --noEmit",
10+
"postinstall": "fumadocs-mdx",
11+
"test": "eslint"
12+
},
13+
"dependencies": {
14+
"@orama/orama": "^3.1.17",
15+
"fumadocs-core": "16.2.5",
16+
"fumadocs-mdx": "14.1.1",
17+
"fumadocs-ui": "16.2.5",
18+
"lucide-react": "^0.556.0",
19+
"next": "16.0.10",
20+
"react": "^19.2.1",
21+
"react-dom": "^19.2.1"
22+
},
23+
"devDependencies": {
24+
"@tailwindcss/postcss": "^4.1.17",
25+
"@types/mdx": "^2.0.13",
26+
"@types/node": "^24.10.2",
27+
"@types/react": "^19.2.7",
28+
"@types/react-dom": "^19.2.3",
29+
"eslint": "^9.39.2",
30+
"eslint-config-next": "^16.0.10",
31+
"postcss": "^8.5.6",
32+
"tailwindcss": "^4.1.17"
33+
}
34+
}

postcss.config.mjs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
var config = {
2+
"plugins": {
3+
"@tailwindcss/postcss": {}
4+
}
5+
};
6+
7+
export default config;

0 commit comments

Comments
 (0)