Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace documentation website with Docusaurus #259

Merged
merged 78 commits into from
May 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
78 commits
Select commit Hold shift + click to select a range
b395912
Remove Previous implementation of documentation
GabLeRoux Apr 24, 2022
86acd76
npx create-docusaurus@latest GameCI classic + move back to root
GabLeRoux Apr 24, 2022
251c82c
Add yarn.lock
GabLeRoux Apr 24, 2022
beed393
Update blog authors for demo
GabLeRoux Apr 24, 2022
598577a
Move assets and public to static
GabLeRoux Apr 24, 2022
b14c785
Update docusaurus config
GabLeRoux Apr 24, 2022
364cb6b
Remove tutorial basics
GabLeRoux Apr 24, 2022
05c88b3
Update theme with GameCI colors 🎨
GabLeRoux Apr 24, 2022
99b2725
Remove docs/tutorial-extras/
GabLeRoux Apr 24, 2022
2790c49
Replace intro with GameCI docs welcome page
GabLeRoux Apr 24, 2022
fe279ff
Update pwshl to powershell + small fixes for docs
GabLeRoux Apr 24, 2022
2892513
Make it node 14
GabLeRoux Apr 24, 2022
bc5535f
Move github docs to root to prevent url change
GabLeRoux Apr 24, 2022
fdabd8f
Add source code links back
GabLeRoux Apr 24, 2022
ebe95b9
Fix a typo in dicsord 🔣
GabLeRoux Apr 24, 2022
1632a93
yarn add @docusaurus/plugin-client-redirects
GabLeRoux Apr 24, 2022
4c9c315
Tried @docusaurus/plugin-client-redirects to redirect discord, but it…
GabLeRoux Apr 24, 2022
9438c8b
Revert "Tried @docusaurus/plugin-client-redirects to redirect discord…
GabLeRoux Apr 24, 2022
c993623
Revert "yarn add @docusaurus/plugin-client-redirects"
GabLeRoux Apr 24, 2022
7d8b808
Add discord page instead of redirect (for now)
GabLeRoux Apr 24, 2022
d8ceb53
Remove /docs/docker/versions link until page is back
GabLeRoux Apr 24, 2022
64bc891
Add iframes for youtube videos
GabLeRoux Apr 24, 2022
3f1ee8b
Replace /discord page with vercel redirect
GabLeRoux Apr 24, 2022
54c06ae
Revert some changes from .gitignore
GabLeRoux Apr 24, 2022
15ae1ce
Update .gitignore and remove .idea
GabLeRoux Apr 24, 2022
b7944ef
Add .nvmrc with Node 14
GabLeRoux Apr 24, 2022
52d010e
Update .gitignore and remove duplicated line
GabLeRoux Apr 24, 2022
ff66696
Remove blog until we start blogging :rocket:
GabLeRoux Apr 24, 2022
50c09f0
Remove deployment documentation since this is handled by vercel
GabLeRoux Apr 24, 2022
a0e2fdb
Add some more links in the footer :rocket:
GabLeRoux Apr 24, 2022
79e22f3
Move docs to folders with prefixed numbers to control menu order
GabLeRoux Apr 30, 2022
f37d62a
Add docsearch config to docusaurus
GabLeRoux Apr 30, 2022
080f935
Add light version of the GameCI logo for navbar
GabLeRoux Apr 30, 2022
ab0470d
Fix relative links (IDE found references, but docusaurus doesn't work…
GabLeRoux Apr 30, 2022
bb464c4
Convert docusaurus to typescript
GabLeRoux Apr 30, 2022
787e350
Fix broken link
GabLeRoux Apr 30, 2022
9eb82d8
Move components to src
GabLeRoux Apr 30, 2022
a144c61
Add DataTable
GabLeRoux Apr 30, 2022
f3687b7
Bring back core
GabLeRoux Apr 30, 2022
d3a421b
WIP: add versions page
GabLeRoux Apr 30, 2022
3ebdf01
WIP: bring back antd for now to fix versions page
GabLeRoux Apr 30, 2022
e687de4
downgrade firebase and reactfire back to main
GabLeRoux Apr 30, 2022
de754a0
WIP: first version of the versions page working in docusaurus
GabLeRoux Apr 30, 2022
0de4296
Get rid of unused components
GabLeRoux Apr 30, 2022
45a0eca
Add missing react import
GabLeRoux Apr 30, 2022
d2ee053
WIP: antd style
GabLeRoux Apr 30, 2022
350078a
Apply dirty trick to load and unload antd css when on versions page
GabLeRoux Apr 30, 2022
5fe62bd
Fix light logo
GabLeRoux Apr 30, 2022
2c75b9c
Add versions.md to add link to versions page
GabLeRoux Apr 30, 2022
614bc60
Add tailwindcss support to docusaurus
GabLeRoux May 4, 2022
09ad892
Integrate tailwindcss and home page
GabLeRoux May 5, 2022
88addd7
remove prose example from home
GabLeRoux May 5, 2022
1167dcf
Apply dirty workaround to prevent tailwindcss preflight to break docs
GabLeRoux May 5, 2022
b8c362b
Remove package-lock.json (we use yarn here)
GabLeRoux May 9, 2022
e61377b
Default to dark mode 😎
GabLeRoux May 14, 2022
f95fc5c
Fix styling of Versions page including dark theme 🤘
GabLeRoux May 14, 2022
0ffd2b0
Add support for docusaurus versions
GabLeRoux May 14, 2022
2f31138
Upgrade to NodeJS 16
GabLeRoux May 14, 2022
4193f3b
Upgrade docusaurus
GabLeRoux May 14, 2022
a6c36f4
Update footer titles and links order
GabLeRoux May 14, 2022
d3d6a15
Improve local image build script
GabLeRoux May 16, 2022
8259a80
add linting and hooks
webbertakken May 17, 2022
3d2ed18
bring back hooks
webbertakken May 17, 2022
54563f6
bring back linting
webbertakken May 17, 2022
8565a30
bring back official sponsor links
webbertakken May 17, 2022
c74c747
skip auditing while in v2 beta of docusaurus
webbertakken May 17, 2022
95ad0db
bring back typescript react file types
webbertakken May 17, 2022
06f15d5
reintroduce spinners
webbertakken May 17, 2022
941a1f4
delete menu structure
webbertakken May 17, 2022
75484db
swizzle Root component for global state and auth
webbertakken May 17, 2022
79fb94c
restore notification functionality
webbertakken May 17, 2022
41729cc
fix formatting
webbertakken May 17, 2022
9a6b75b
test
GabLeRoux May 18, 2022
75c25f5
test
GabLeRoux May 18, 2022
3d63f97
Remove empty page from previous version
GabLeRoux May 18, 2022
3ce9bd2
Remove unecessary custom css for svgs
GabLeRoux May 18, 2022
c071f47
Apply small updates to documentation fixing todos and file titles
GabLeRoux May 18, 2022
57294e6
Implement custom dracula theme for better yaml
GabLeRoux May 18, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
**/node_modules/**
**/.next/**
.docusaurus/**
build/**
13 changes: 12 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,17 @@
// From experience, named exports are almost always desired. I got tired of this rule
"import/prefer-default-export": "off",
// Firebase requires importing each module that's used
"import/no-duplicates": "off"
"import/no-duplicates": "off",
// Allow camelCase and PascalCase (kebab-case for md files)
"unicorn/filename-case": [
"error",
{
"cases": {
"camelCase": true,
"pascalCase": true,
"kebabCase": true
}
}
]
}
}
36 changes: 18 additions & 18 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
# Dependencies
/node_modules
/.pnp
.pnp.js

# testing
# Testing
/coverage

# next.js
/.next/
/out/

# production
# Production
/build
/.search/*
!/.search/.gitkeep
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two lines can be removed and this section can be merged with Generated files, rest looks good.

And I think we'll need LFS (.gitattributes) for the images. This one might be quite complete and suitable: https://gist.github.com/webbertakken/ff250a0d5e59a8aae961c2e509c07fbc


# misc
.DS_Store
.idea
.vscode
.vercel

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Generated files
.docusaurus
.cache-loader

# local env files
# Environment files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

# npm and yarn debug files
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Misc
.DS_Store
.idea
.vscode
.vercel
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v12.16.2
GabLeRoux marked this conversation as resolved.
Show resolved Hide resolved
v14.19.1
12 changes: 12 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# Node
**/node_modules/**

# Legacy - Keep this for a while, since people might still have this folder
**/.next/**

# Docusaurus
.docusaurus/**
build/**

# Use stylelint instead
*.less
*.css
*.scss
11 changes: 0 additions & 11 deletions @types/filetypes.d.ts

This file was deleted.

5 changes: 0 additions & 5 deletions @types/react.d.ts

This file was deleted.

26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
# GameCI

Documentation for open source GameCI projects. You can find the `.md` files inside the [docs](./docs) folder.
The live version is available on [game.ci](https://game.ci).
The live version is available on [game.ci](https://game.ci). This website is built using
[Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Run the documentation locally
### Installation

You will need `NodeJS v12.x` and the latest
[yarn](https://classic.yarnpkg.com/en/docs/install/).
```bash
yarn
```

1. Clone repository
2. Run the following commands in the folder to install requirements and run the development server
### Local Development

```bash
yarn
yarn dev
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```bash
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Community

Feel free to join us on
Expand Down
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
23 changes: 23 additions & 0 deletions blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
gableroux:
name: Gabriel Le Breton
title: Developer, GameCI contributor, Open Source enthusiast and way more
url: https://github.com/gableroux
image_url: https://github.com/gableroux.png

webbertakken:
name: Webber Takken
title: 🍀 Making complicated things easier for everyone
url: https://github.com/webbertakken
image_url: https://github.com/webbertakken.png

frostebite:
name: Mark D. "Fisher"
title: Lead game developer @bossastudios, former product manager @unity3d, arma modder. Game ai, networking, terrain
url: https://www.bossastudios.com/
image_url: https://images.opencollective.com/frostebite/b35bd63/avatar/256.png

davidmfinol:
name: David Finol
title: Lead developer @bossastudios, former product manager @unity3d, arma modder. Game ai, networking, terrain
url: https://github.com/davidmfinol
image_url: https://github.com/davidmfinol.png
27 changes: 0 additions & 27 deletions components/layout/base-layout.tsx

This file was deleted.

15 changes: 0 additions & 15 deletions components/layout/footer/footer.js

This file was deleted.

3 changes: 0 additions & 3 deletions components/layout/footer/vercel.svg

This file was deleted.

20 changes: 0 additions & 20 deletions components/layout/header/nav-bar.module.scss

This file was deleted.

65 changes: 0 additions & 65 deletions components/layout/header/nav-bar.tsx

This file was deleted.

Loading