From b8e1fb20e97807feb0095f4a96cdb373ddf0dee2 Mon Sep 17 00:00:00 2001 From: 641i130 <46945263+641i130@users.noreply.github.com> Date: Thu, 20 Jul 2023 22:03:15 -0500 Subject: [PATCH] Updated --- README.md | 15 +++++++++++++-- build.sh | 8 ++++++++ mkdocs-build.txt | 29 ----------------------------- 3 files changed, 21 insertions(+), 31 deletions(-) create mode 100644 build.sh delete mode 100644 mkdocs-build.txt diff --git a/README.md b/README.md index 0e7ca5c..d37220a 100644 --- a/README.md +++ b/README.md @@ -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 +``` diff --git a/build.sh b/build.sh new file mode 100644 index 0000000..1c37bdb --- /dev/null +++ b/build.sh @@ -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 diff --git a/mkdocs-build.txt b/mkdocs-build.txt deleted file mode 100644 index 38f8b93..0000000 --- a/mkdocs-build.txt +++ /dev/null @@ -1,29 +0,0 @@ -# build and deploy mkdocs to codeberg pages -# This assumes your code lives in one repo, and you have a /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 @ - from_secret: codeberg_push_from_ci_priv_key \ No newline at end of file