Skip to content

Commit 3ce8c40

Browse files
feat: initialize Docusaurus documentation and automate deployment via GitHub Actions
1 parent 0ea52ce commit 3ce8c40

7 files changed

Lines changed: 16191 additions & 13 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ permissions:
1818
jobs:
1919
deploy:
2020
runs-on: ubuntu-latest
21+
env:
22+
DOCUSAURUS_NO_PROGRESS: true
2123
steps:
2224
- name: Checkout
2325
uses: actions/checkout@v4

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2026 programmersd21
3+
Copyright (c) 2026 kairo contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/assets/.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Ignore everything in this directory
2+
*
3+
4+
# Except for these:
5+
!.gitignore
6+
!*.png
7+
!*.jpg
8+
!*.jpeg
9+
!*.gif
10+
!*.svg
11+
!*.webp
12+
!*.mp4
13+
!*.mov
14+
15+
# Ignore OS-specific junk
16+
.DS_Store
17+
Thumbs.db

docs/assets/logo.png

5.09 KB
Loading

docs/docusaurus.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// @ts-check
22
// Note: type annotations allow type checking and IDEs autocompletion
33

4-
const {themes} = require('prism-react-renderer');
4+
const { themes } = require('prism-react-renderer');
55
const lightTheme = themes.github;
66
const darkTheme = themes.dracula;
77

@@ -22,6 +22,8 @@ const config = {
2222
organizationName: 'programmersd21', // Usually your GitHub org/user name.
2323
projectName: 'kairo', // Usually your repo name.
2424

25+
staticDirectories: ['static', 'assets'],
26+
2527
onBrokenLinks: 'throw',
2628
onBrokenMarkdownLinks: 'warn',
2729

@@ -62,7 +64,7 @@ const config = {
6264
title: 'Kairo',
6365
logo: {
6466
alt: 'Kairo Logo',
65-
src: 'img/logo.png',
67+
src: 'logo.png',
6668
},
6769
items: [
6870
{

0 commit comments

Comments
 (0)