BinaryNinja/tvapp2
4
1
Fork 0
mirror of https://github.com/TheBinaryNinja/tvapp2.git synced 2026-06-04 02:35:42 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(mkdocs): update batch script

Browse Source
This commit is contained in:
Aetherx
2025-03-26 04:05:08 -07:00
parent f8a2bdd464
commit 5f1f9f7fff
2 changed files with 27 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/mkdocs.yml
View File

@@ -158,13 +158,10 @@ nav:
- Conventions: 'about/conventions.md' - Conventions: 'about/conventions.md'
- Tags: 'about/tags.md' - Tags: 'about/tags.md'
- Changelog: 'about/changelog.md' - Changelog: 'about/changelog.md'
- Backers: 'backers/index.md'
plugins: plugins:
- search: - search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- tags:
tags_file: about/tags.md
- group: - group:
plugins: plugins:
- optimize - optimize

45
docs/run-mkdocs.bat
View File

@@ -6,15 +6,19 @@ MODE con:cols=125 lines=120
MODE 125,40 MODE 125,40
GOTO comment_end GOTO comment_end
Starts up mkdocs from a windows system. @usage Starts up mkdocs from a windows system.
Ensure you have defined `GH_TOKEN` or the git-committers plugin will rate limit you. Ensure you have defined `GH_TOKEN` or the git-committers plugin will rate limit you.
setx /m GH_TOKEN "github_pat_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" setx /m GH_TOKEN "github_pat_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
If using a Github Workflow, create a new secret in the repo settings named `GH_TOKEN` If using a Github Workflow, create a new secret in the repo settings named `GH_TOKEN`
and give it your Github fine-grained personal access token. and give it your Github fine-grained personal access token.
The token variable is defined in mkdocs.yml The token variable is defined in mkdocs.yml
@update use the following commands to update mkdocs and the mkdocs-material theme:
pip install --upgrade mkdocs
pip install --upgrade --force-reinstall mkdocs-material
:comment_end :comment_end
@@ -30,28 +34,33 @@ set dir_home=%~dp0
:: define: env variable :: define: env variable
:: # :: #
set TOKEN=%GH_TOKEN2% echo ------------------------------------------------------------------------------------------------
echo --------------------------------------------------------------------------------
echo Mkdocs Launcher echo Mkdocs Launcher
echo -------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------------------------
IF [!TOKEN!]==[] (
echo --------------------------------------------------------------------------------
echo GH_TOKEN not defined. Open %0%
echo Create a new one at https://github.com/settings/personal-access-tokens
echo --------------------------------------------------------------------------------
set /P TOKEN= Enter Github Personal Access Token (fine-grained):
IF "!GH_TOKEN!"=="" (
echo GH_TOKEN not defined.
echo Open %0%
echo Create a new one at:
echo https://github.com/settings/personal-access-tokens
echo ------------------------------------------------------------------------------------------------
set /p TOKEN=" Enter Github Personal Access Token (fine-grained): "
) )
echo GH_TOKEN: !TOKEN! echo GH_TOKEN: !GH_TOKEN!
echo. echo.
echo. echo.
echo Creating environment variable GH_TOKEN
setx GH_TOKEN "!GH_TOKEN!"
timeout 2 > NUL
:: # :: #
:: start mkdocs :: start mkdocs
:: # :: #
echo Starting mkdocs ... echo Starting mkdocs ...
start cmd /k "mkdocs serve --clean" start cmd /k "mkdocs serve --clean"
timeout 5 > NUL