Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
tpill90 committed Jul 14, 2024
1 parent 49dfdae commit c292dfc
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
51 changes: 51 additions & 0 deletions docs/mkdocs/SyntaxHighlightingTest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Test
---

<!-- This is a test page used to make sure that all the syntax highlighting doesnt look bad --->

## 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.

5 changes: 3 additions & 2 deletions docs/mkdocs/install-guides/Scheduled-Job.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,16 @@ 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
<!--- TODO the syntax highlighting here is absolutely awful -->
```ini
[Unit]
Description={{prefill_name}}
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}}
Expand Down

0 comments on commit c292dfc

Please sign in to comment.