Skip to content

Commit 6e5fa83

Browse files
authored
Update README.md
1 parent 6c784e3 commit 6e5fa83

File tree

1 file changed

+34
-46
lines changed

1 file changed

+34
-46
lines changed

README.md

Lines changed: 34 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,30 @@
1111
<img src="https://img.shields.io/github/stars/game-ci/documentation.svg">
1212
<img src="https://img.shields.io/github/last-commit/game-ci/documentation.svg">
1313
<p>
14-
15-
<br>
16-
17-
<h2 align="center"> Welcome </h2>
18-
<p align="center">
19-
Welcome to the GameCI documentation repo! Here you will find the documentation assests for GameCI and it's related open-source projects. This documentation is also availble on our website <a href="https://game.ci">game.ci</a>
20-
</p>
2114

2215
<br>
16+
17+
## Welcome
2318

24-
<h2 align="center"> Markdown Files </h2>
25-
<p align="center">
26-
<a href="docs/02-getting-started">Getting Started with GameCI</a> <br>
27-
<a href="docs/03-github">Github Actions</a> <br>
28-
<a href="docs/05-gitlab">Gitlab Pipelines</a> <br>
29-
<a href="docs/11-circleci">CircleCi</a> <br>
30-
<a href="docs/08-docker">Docker</a> <br>
31-
<a href="docs/03-github-cloud-runner">Github Cloud Runner</a> <br>
32-
<a href="docs/09-troubleshooting">Troubleshooting</a> <br>
33-
<a href="docs/10-faq">FAQ</a> <br>
34-
</p>
35-
36-
<br>
37-
38-
<h2 align="center"> Building the Docs Site with <a href="https://docusaurus.io/">Docusaurus 2.</a></h2>
19+
Welcome to the GameCI documentation repo! Here you will find the documentation assests for GameCI and it's related open-source projects. The live documentation site availble at <a href="https://game.ci">game.ci</a>.
20+
21+
You may also view the markdown files directly at the following links:
22+
- <a href="docs/02-getting-started">Getting Started with GameCI</a> <br>
23+
- <a href="docs/03-github">Github Actions</a> <br>
24+
- <a href="docs/05-gitlab">Gitlab Pipelines</a> <br>
25+
- <a href="docs/11-circleci">CircleCi</a> <br>
26+
- <a href="docs/08-docker">Docker</a> <br>
27+
- <a href="docs/03-github-cloud-runner">Github Cloud Runner</a> <br>
28+
- <a href="docs/09-troubleshooting">Troubleshooting</a> <br>
29+
- <a href="docs/10-faq">FAQ</a> <br>
3930

4031
<br>
4132

42-
<p align="center">
43-
<img height=150px src="static/img/undraw_docusaurus_react.svg"> <br>
44-
</p>
45-
46-
### Pre-reqs
33+
## Building the Docs Site
34+
35+
Built with <a href="https://docusaurus.io/">Docusaurus 2.</a>
36+
37+
*Pre-reqs*
4738

4839
1. This project has a hard dependancy on Node16. You will need to make sure that you have the proper version of node installed to avoid errors.
4940

@@ -54,7 +45,7 @@
5445

5546
- <a href="https://classic.yarnpkg.com/lang/en/docs/install"> Official yarn installation docs.</a>
5647

57-
### Usage
48+
*Usage*
5849

5950
1. Install project dependancies
6051

@@ -79,31 +70,28 @@ contents hosting service.
7970
yarn build
8071
```
8172

82-
___
8373
<br>
8474

85-
<h2 align="center"> Meet the Community </h2>
75+
## Meet the Community
8676

87-
<p align="center"> Join us on <a href="assets/readme/Discord.svg)](https://game.ci/discord">Discord</a> and engage
88-
with the growing community of engineers, artists, hobbyists, and professionals using GameCI to build, test, and publish their projects everyday.<p>
89-
90-
<br>
91-
92-
<h2 align="center"> Support the Team </h2>
93-
<p align="center"> GameCI is free for everyone forever. You can support the peolpe who make GameCI pssible on <a href="https://opencollective.com/game-ci">OpenCollective</a> <p>
77+
Join us on <a href="assets/readme/Discord.svg)](https://game.ci/discord">Discord</a> and engage
78+
with the growing community of engineers, artists, hobbyists, and professionals using GameCI to build, test, and publish their projects everyday.
9479

9580
<br>
9681

97-
<h2 align="center"> Licence </h2>
98-
<p align="center"> This repository is <a href="./LICENSE">MIT<a> licensed.
99-
This includes all contributions from the community.
100-
<p>
82+
## Support the Team
83+
84+
GameCI is free for everyone forever. You can support the peolpe who make GameCI pssible on <a href="https://opencollective.com/game-ci">OpenCollective</a>
10185

10286
<br>
10387

104-
<h2 align="center"> Sponsors </h2>
105-
<p align="center">
106-
<img src="https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white" href="https://vercel.com?utm_source=game-ci">
107-
<p>
108-
88+
## Licence
89+
90+
This repository is <a href="./LICENSE">MIT<a> licensed. This includes all contributions from the community.
91+
10992
<br>
93+
94+
## Sponsors
95+
96+
<img src="https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white" href="https://vercel.com?utm_source=game-ci">
97+

0 commit comments

Comments
 (0)