This commit is contained in:
641i130 2023-07-20 22:03:15 -05:00
parent 0b7111a1e9
commit b8e1fb20e9
3 changed files with 21 additions and 31 deletions

View file

@ -1,6 +1,6 @@
# ll-hax-docs
Documentation for all love live related game hacking.
Documentation for *all* Love Live related game hacking.
# Mkdocs Environment:
```python
@ -8,4 +8,15 @@ conda create --name ll-hax-docs python=3.8.2
conda activate ll-hax-docs
pip install mkdocs mkdocs-material
```
https://codeberg.org/Codeberg-CI/examples/src/branch/main/Python/mkdocs.yml
# Build (and publish)
```bash
mkdocs build -f ./mkdocs.yml -d docs_build
git switch pages
mv -f docs_build/* .
rm -rf docs_build
git add .
git commit -m "Updated"
git push
git switch main
```

8
build.sh Normal file
View file

@ -0,0 +1,8 @@
mkdocs build -f ./mkdocs.yml -d docs_build
git switch pages
mv -f docs_build/* .
rm -rf docs_build
git add .
git commit -m "Updated"
git push
git switch main

View file

@ -1,29 +0,0 @@
# build and deploy mkdocs to codeberg pages
# This assumes your code lives in one repo, and you have a <owner>/pages
# repo which will be used to host the built pages.
steps:
build-docs:
# build the docs in /docs with mkdocs and
# add the .domains file for codeberg pages
image: squidfunk/mkdocs-material
commands:
- mkdocs build -f ./mkdocs.yml -d docs_build
- git switch --orphan pages
- mv docs_build/* .
- echo -e 'carette.codeberg.page\npages.carette.codeberg.page' > .domains
deploy-docs:
# Push the resulting files to openfindata/pages
# to deploy
image: appleboy/drone-git-push
settings:
branch: main
remote: git@codeberg.org:carette/ll-hax-docs.git
force: true
commit: true
ssh_key:
# created using woodpecker cli with:
# woodpecker secret add -repository carette/ll-hax-docs \
# -name codeberg_push_from_ci_priv_key -value @<path_to_privkey_file>
from_secret: codeberg_push_from_ci_priv_key