Skip to content

Commit 37e66b0

Browse files
jon-belljon-bell
committed
Initial commit
0 parents  commit 37e66b0

29 files changed

+18851
-0
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
17+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: false
21+
22+
jobs:
23+
deploy:
24+
name: Deploy to GitHub Pages
25+
runs-on: ubuntu-latest
26+
steps:
27+
- uses: actions/checkout@v4
28+
with:
29+
fetch-depth: 0
30+
- uses: actions/setup-node@v4
31+
with:
32+
node-version: 18
33+
cache: npm
34+
35+
- name: Install dependencies
36+
run: npm install
37+
- name: Build website
38+
run: npm run build
39+
- name: Setup Pages
40+
uses: actions/configure-pages@v5
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: 'build'
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Pawtograder Documentation
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
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.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.

‎docs/developers/intro.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Welcome to Pawtograder - Developer Guide
6+
7+
This guide will help you understand and contribute to the Pawtograder project. Learn about the architecture, development setup, and how to extend the system.
8+
9+
TODO

‎docs/staff/intro.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Welcome to Pawtograder - Course Staff Guide
6+
7+
This guide will help you set up and manage Pawtograder for your course. Learn how to create assignments, manage submissions, and provide effective feedback to your students.
8+
9+
TODO

‎docs/students/intro.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Welcome to Pawtograder - Student Guide
6+
7+
Welcome to the Pawtograder documentation for students! This guide will help you understand how to use Pawtograder for your programming assignments.
8+
9+
TODO

‎docusaurus.config.ts‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
import {themes as prismThemes} from 'prism-react-renderer';
2+
import type {Config} from '@docusaurus/types';
3+
import type * as Preset from '@docusaurus/preset-classic';
4+
5+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6+
7+
const config: Config = {
8+
title: 'Pawtograder',
9+
tagline: 'Where every submission gets a round of appaws.',
10+
favicon: 'img/favicon.ico',
11+
12+
// Set the production url of your site here
13+
url: 'https://docs.pawtograder.com',
14+
// Set the /<baseUrl>/ pathname under which your site is served
15+
// For GitHub pages deployment, it is often '/<projectName>/'
16+
baseUrl: '/',
17+
18+
// GitHub pages deployment config.
19+
// If you aren't using GitHub pages, you don't need these.
20+
organizationName: 'pawtograder', // Usually your GitHub org/user name.
21+
projectName: 'docs', // Usually your repo name.
22+
23+
onBrokenLinks: 'throw',
24+
onBrokenMarkdownLinks: 'warn',
25+
26+
// Even if you don't use internationalization, you can use this field to set
27+
// useful metadata like html lang. For example, if your site is Chinese, you
28+
// may want to replace "en" with "zh-Hans".
29+
i18n: {
30+
defaultLocale: 'en',
31+
locales: ['en'],
32+
},
33+
34+
presets: [
35+
[
36+
'classic',
37+
{
38+
docs: {
39+
path: "docs/staff",
40+
routeBasePath: "staff",
41+
sidebarPath: './sidebars/staff.ts',
42+
// Please change this to your repo.
43+
// Remove this to remove the "edit this page" links.
44+
editUrl:
45+
'https://github.com/pawtograder/docs/tree/main/',
46+
},
47+
theme: {
48+
customCss: './src/css/custom.css',
49+
},
50+
} satisfies Preset.Options,
51+
],
52+
],
53+
54+
plugins: [
55+
[
56+
'@docusaurus/plugin-content-docs',
57+
{
58+
id: 'students',
59+
path: 'docs/students',
60+
sidebarPath: './sidebars/students.ts',
61+
routeBasePath: 'students',
62+
},
63+
],
64+
// [
65+
// '@docusaurus/plugin-content-docs',
66+
// {
67+
// id: 'staff',
68+
// path: 'docs/staff',
69+
// sidebarPath: './sidebars/staff.ts',
70+
// routeBasePath: 'staff',
71+
// },
72+
// ],
73+
[
74+
'@docusaurus/plugin-content-docs',
75+
{
76+
id: 'developers',
77+
path: 'docs/developers',
78+
sidebarPath: './sidebars/developers.ts',
79+
routeBasePath: 'developers',
80+
},
81+
],
82+
],
83+
84+
themeConfig: {
85+
// Replace with your project's social card
86+
image: 'img/pawtograder-social-card.jpg',
87+
navbar: {
88+
title: 'Pawtograder',
89+
logo: {
90+
alt: 'Pawtograder Logo',
91+
src: 'img/logo.svg',
92+
},
93+
items: [
94+
{
95+
type: 'doc',
96+
docId: 'intro',
97+
position: 'left',
98+
label: 'Students',
99+
docsPluginId: 'students',
100+
},
101+
{
102+
type: 'doc',
103+
docId: 'intro',
104+
position: 'left',
105+
label: 'Course Staff',
106+
// docsPluginId: 'staff',
107+
},
108+
{
109+
type: 'doc',
110+
docId: 'intro',
111+
position: 'left',
112+
label: 'Developers',
113+
docsPluginId: 'developers',
114+
},
115+
{
116+
href: 'https://github.com/pawtograder',
117+
label: 'GitHub',
118+
position: 'right',
119+
},
120+
],
121+
},
122+
footer: {
123+
style: 'dark',
124+
links: [
125+
// {
126+
// title: 'Documentation',
127+
// items: [
128+
// {
129+
// label: 'Students Guide',
130+
// to: '/students/intro',
131+
// },
132+
// {
133+
// label: 'Course Staff Guide',
134+
// to: '/staff/intro',
135+
// },
136+
// {
137+
// label: 'Developer Guide',
138+
// to: '/developers/intro',
139+
// },
140+
// ],
141+
// },
142+
// {
143+
// title: 'Community',
144+
// items: [
145+
// {
146+
// label: 'Stack Overflow',
147+
// href: 'https://stackoverflow.com/questions/tagged/docusaurus',
148+
// },
149+
// {
150+
// label: 'Discord',
151+
// href: 'https://discordapp.com/invite/docusaurus',
152+
// },
153+
// {
154+
// label: 'X',
155+
// href: 'https://x.com/docusaurus',
156+
// },
157+
// ],
158+
// },
159+
// {
160+
// title: 'More',
161+
// items: [
162+
// {
163+
// label: 'Blog',
164+
// to: '/blog',
165+
// },
166+
// {
167+
// label: 'GitHub',
168+
// href: 'https://github.com/facebook/docusaurus',
169+
// },
170+
// ],
171+
// },
172+
],
173+
copyright: `Copyright © ${new Date().getFullYear()} Jonathan Bell.`,
174+
},
175+
prism: {
176+
theme: prismThemes.github,
177+
darkTheme: prismThemes.dracula,
178+
},
179+
} satisfies Preset.ThemeConfig,
180+
};
181+
182+
export default config;

0 commit comments

Comments
 (0)