Skip to content

Commit

Permalink
Add basic mkdocs site
Browse files Browse the repository at this point in the history
  • Loading branch information
p2004a committed Aug 4, 2024
1 parent 30a4811 commit dbbd28d
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: ci
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install -r requirements.txt
- run: mkdocs gh-deploy --force
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.venv
.cache
/site
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Welcome

This documentation site describes what are all of the components the Beyond All
Reason (BAR) Infrastructure area, how they all connect to each other, and how we
would like to evolve the system in the future.

BAR Infrastructure area contains all the software, configuration and resources
that support running of the [Beyond All Reason](https://github.com/beyond-all-reason/Beyond-All-Reason)
game on the [Recoil](https://github.com/beyond-all-reason/spring) engine, which
includes: lobby server, launcher, game files hosting, multiplayer game servers,
servers management, and more.
13 changes: 13 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
site_name: BAR Infrastructure
site_url: https://beyond-all-reason.github.io/infrastructure
repo_url: https://github.com/beyond-all-reason/infrastracture
edit_uri: edit/main/docs/
theme:
name: material
features:
- content.action.edit
- content.action.view
plugins:
- git-revision-date-localized:
enable_creation_date: true
- search
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs~=1.6.0
mkdocs-material~=9.5.31
mkdocs-git-revision-date-localized-plugin~=1.2.6

0 comments on commit dbbd28d

Please sign in to comment.