From 8651f7259ab3465d771b46f337a129ce27b39b81 Mon Sep 17 00:00:00 2001 From: Akkarinage Date: Tue, 28 May 2024 11:34:29 +0100 Subject: [PATCH] Formatting/general cleaning (#13) --- .github/workflows/deploy_guides.yml | 5 ++--- guides/debugging.md | 2 +- guides/index.md | 6 +++--- guides/installing/debian.md | 11 ++++++++++- guides/stylesheets/extra.css | 4 ---- mkdocs.yml | 8 ++++---- 6 files changed, 20 insertions(+), 16 deletions(-) diff --git a/.github/workflows/deploy_guides.yml b/.github/workflows/deploy_guides.yml index c9354db..4efa12b 100644 --- a/.github/workflows/deploy_guides.yml +++ b/.github/workflows/deploy_guides.yml @@ -1,10 +1,9 @@ name: Publish Guides - on: # Allow manual deployment workflow_dispatch: - + # Trigger when code is merged to `master` branch push: branches: @@ -16,7 +15,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout main - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Deploy docs diff --git a/guides/debugging.md b/guides/debugging.md index ad105af..f3a5eeb 100644 --- a/guides/debugging.md +++ b/guides/debugging.md @@ -41,4 +41,4 @@ Instead of actually pausing the execution you can use this to execute a piece of ### Anything missing? -Should you have any questions, don't hesitate to ask questions at our Discord. We'll be happy to help. \ No newline at end of file +Should you have any questions, don't hesitate to ask questions at our Discord. We'll be happy to help. diff --git a/guides/index.md b/guides/index.md index 95a5b43..7686174 100644 --- a/guides/index.md +++ b/guides/index.md @@ -1,8 +1,8 @@ [![https://github.com/rathena/rathena](img/rathena_banner_1.png)](https://github.com/rathena/rathena) -[![GitHub](https://img.shields.io/github/license/rathena/rathena?style=for-the-badge)](https://github.com/rathena/rathena/blob/master/LICENSE) -[![GitHub last commit](https://img.shields.io/github/last-commit/rathena/user-guides?label=updated&style=for-the-badge)](https://github.com/rathena/user-guides/commits/master) -[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rathena/user-guides/deploy_guides.yml?label=automatic%20building&style=for-the-badge)](https://github.com/rathena/user-guides/actions) +[![GitHub](https://img.shields.io/github/license/rathena/rathena?style=for-the-badge)](https://github.com/rathena/rathena/blob/master/LICENSE) +[![GitHub last commit](https://img.shields.io/github/last-commit/rathena/user-guides?label=updated&style=for-the-badge)](https://github.com/rathena/user-guides/commits/master) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rathena/user-guides/deploy_guides.yml?label=automatic%20building&style=for-the-badge)](https://github.com/rathena/user-guides/actions) ![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/rathena/user-guides?label=Open%20PR&style=for-the-badge) # Hello~! What?! diff --git a/guides/installing/debian.md b/guides/installing/debian.md index d7986ec..4e28474 100644 --- a/guides/installing/debian.md +++ b/guides/installing/debian.md @@ -7,6 +7,7 @@ This guide covers the installation via CLI and *does not* include instructions f ## Pre-Requisites ### In General + * A basic understanding of Linux based Operating Systems. * A basic understanding of the SSH tool Putty. * A basic understanding of MySQL (or RDBMS in general). @@ -14,9 +15,11 @@ This guide covers the installation via CLI and *does not* include instructions f * A basic understanding that "if at first you don't succeed, search the forums" will be your saving-grace in the event of errors. ### Debian 10 + You should ensure that your system is up-to-date by first: `apt-get update` ### Installing Requirements + We need the following applications to compile rAthena on Debian 10: ``` apt-get install git make libmariadb-dev libmariadbclient-dev libmariadbclient-dev-compat gcc g++ zlib1g-dev libpcre3-dev @@ -29,6 +32,7 @@ apt-get install -y nano ``` ### MySQL + For the installation instructions of MySQL, please see the [relevant installation page](https://github.com/rathena/rathena/wiki/Install-MySQL#linux). @@ -36,7 +40,8 @@ For the installation instructions of MySQL, please see the [relevant installatio rAthena uses git for revision control, and hosts the git repository on Github. -### Cloning +### Cloning + You can obtain the latest version of rAthena by typing the following command. This will place rAthena in a folder called rAthena in your home directory, but you are free to change it to whatever you like: ``` @@ -83,9 +88,11 @@ Recompiling is the same as compiling. You can throw the code into a one-liner, i ## Starting rAthena + The provided method of running rAthena will work perfectly fine, but this author's personal preference is shown below as an *alternative method*. ### Provided Method + Use the following commands * To Start: @@ -114,6 +121,7 @@ You can install dos2unix with `apt-get install dos2unix` and then run `dos2unix You will now be able to use `./athena-start start` after `chmod a+x athena-start`. ### Alternative Method + Firstly, install `screen`: ``` apt-get install -y screen @@ -146,6 +154,7 @@ There are screens on: ``` ### Connections + If you've just started your servers and get some errors, don't worry, it's because you haven't configured them yet. We have a handy guide [here](https://github.com/rathena/rathena/wiki/connecting) that will talk you through what you need to change in order to get your servers up and running successfully. diff --git a/guides/stylesheets/extra.css b/guides/stylesheets/extra.css index a66b582..0e5a87b 100644 --- a/guides/stylesheets/extra.css +++ b/guides/stylesheets/extra.css @@ -5,7 +5,3 @@ .md-typeset a { color: #5caed6 } - -.md-typeset h1 { - color: #dae1e8; -} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d94d61b..38fe4be 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -54,14 +54,14 @@ theme: palette: - scheme: default toggle: - icon: material/toggle-switch-off-outline + icon: material/toggle-switch-off-outline name: Switch to dark mode primary: custom accent: cyan - - scheme: slate + - scheme: slate toggle: icon: material/toggle-switch - name: Switch to light mode + name: Switch to light mode primary: custom accent: cyan extra: @@ -71,7 +71,7 @@ extra: - icon: fontawesome/solid/message link: https://rathena.org/board/ - icon: fontawesome/brands/wikipedia-w - link: https://rathena.org/wiki/ + link: https://github.com/rathena/rathena/wiki/ - icon: fontawesome/brands/discord link: https://discord.gg/rathena-96459614895226880