diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 86038ef8..45914a95 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -33,7 +33,7 @@ theme: #TODO fix the code highlighting theme. Looks crappy highlightjs: true # Examples of themes - https://highlightjs.org/demo - # Find which themese are available on the cdn - https://cdnjs.com/libraries/highlight.js + # Find which themes are available on the cdn - https://cdnjs.com/libraries/highlight.js hljs_style: default hljs_languages: - powershell @@ -83,6 +83,7 @@ plugins: nav: - Welcome: index.md + - Syntax test page: SyntaxHighlightingTest.md - Frequently Asked Questions: faq.md - Install Guides: - ... | flat | install-guides/*.md diff --git a/docs/mkdocs/SyntaxHighlightingTest.md b/docs/mkdocs/SyntaxHighlightingTest.md new file mode 100644 index 00000000..821ebb38 --- /dev/null +++ b/docs/mkdocs/SyntaxHighlightingTest.md @@ -0,0 +1,51 @@ +--- +title: Test +--- + + + +## Bash + +```powershell +./{{prefill_name}} prefill --top --os linux --verbose +choco install dotnet-sdk --version=8.0.100 +git clone --recurse-submodules -j8 https://github.com/tpill90/steam-lancache-prefill.git +git submodule update --init --recursive +``` + +## Ini + +```ini +[Unit] +Description={{prefill_name}} + +# Set this to the directory where {{prefill_name}} is installed. +# Example : /home/tim/{{prefill_name}} +WorkingDirectory= +``` + +## Powershell +```powershell +if(!(Test-Path $profile)) +{ + New-Item -Path $profile -Type File -Force +} +if(!(gc $profile).Contains("OutputEncoding")) +{ + ac $profile "[console]::InputEncoding = [console]::OutputEncoding = [System.Text.UTF8Encoding]::new()"; + & $profile; +} +``` + + +## Project Layout + + mkdocs.yml # Mkdocs root configuration file. + mkdocs/ + index.md # The documentation homepage. + assets/ # Contains custom Javascript and CSS used on the docs site + custom_theme/ + img/ + img/svg/ # The .ansi files in the parent directory will be rendered here. + ... # Other markdown pages, images and other files. + diff --git a/docs/mkdocs/install-guides/Scheduled-Job.md b/docs/mkdocs/install-guides/Scheduled-Job.md index 28cf0d24..6f2ce68e 100644 --- a/docs/mkdocs/install-guides/Scheduled-Job.md +++ b/docs/mkdocs/install-guides/Scheduled-Job.md @@ -34,7 +34,7 @@ Next, we will setup the job that will be triggered nightly by the `timer` that w !!! Note The values of `User`, `WorkingDirectory`, and `ExecStart` will need to be configured to point to your **{{prefill_name}}** install location. -#TODO the syntax highlighting here is absolutely awful + ```ini [Unit] Description={{prefill_name}} @@ -42,7 +42,8 @@ After=remote-fs.target Wants=remote-fs.target [Service] -User=# Replace with your username +# Replace with your username +User= # Set this to the directory where {{prefill_name}} is installed. # Example : /home/tim/{{prefill_name}}