diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 767d1a0d4d..0000000000 Binary files a/.DS_Store and /dev/null differ diff --git a/.gitignore b/.gitignore index c959f47f8d..034d13f507 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,3 @@ /site .DS_Store -**/.DS_Store -.DS_Store -docs/.DS_Store -.DS_Store -.venv \ No newline at end of file +.venv diff --git a/.travis.yml b/.travis.yml index dbc6a94094..e582ff7b4b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,5 +5,6 @@ install: - pip install mkdocs - pip install mkdocs-material - pip install pymdown-extensions + - pip install pygments script: - mkdocs build diff --git a/docs/.DS_Store b/docs/.DS_Store deleted file mode 100644 index 70781c5b08..0000000000 Binary files a/docs/.DS_Store and /dev/null differ diff --git a/docs/guides/install-gnu.md b/docs/guides/install-gnu.md index 4de331d9ca..0105779543 100644 --- a/docs/guides/install-gnu.md +++ b/docs/guides/install-gnu.md @@ -1,136 +1,174 @@ -# Downloading, Installing and Updating RetroArch +--- +title: Downloading, Installing and Updating RetroArch on GNU/Linux +description: Instructions for setting up RetroArch on GNU/Linux systems. +--- - +# Installing RetroArch on Linux -## GNU/Linux +This page contains descriptions of several officially-supported methods of +installing RetroArch on systems running the GNU/Linux kernel. -### Flatpak + + +--- + +## Flatpak (suitable for most Linux distributions) Flatpak is a distribution-agnostic packaging format with broad support -throughout the Linux ecosystem. An official -[RetroArch flatpak][retroarch-flatpak] is published in the Flathub repository, -and can be installed in just three easy steps: +throughout the Linux ecosystem. An official [RetroArch +flatpak][retroarch-flatpak] is published in the Flathub repository, and can be +installed in just three easy steps: -#### Installation +### Installation 1. Ensure that Flatpak is [enabled on your system][flatpak-setup] by opening the terminal and confirming that the following command exits with no errors: - ```sh - flatpak --installations - ``` + ``` shell + flatpak --installations + ``` -1. Confirm that the Flathub repository is configured as a - [flatpak remote][flatpak-remote], so that packages may be installed from it. - You can examine the flatpak remotes currently enabled on your system with - this terminal command (shown with default output): +1. Confirm that the Flathub repository is configured as a [flatpak + remote][flatpak-remote], so that packages from it may be installed. You can + examine the flatpak remotes currently enabled on your system with this + terminal command (shown with default output): - ```console - $ flatpak remotes --columns=name,url,homepage + ``` shell-session hl_lines="4" + ra@libretro:~$ flatpak remotes --columns=name,url,homepage - Name URL Homepage - flathub https://dl.flathub.org/repo/ https://flathub.org/ - ``` + Name URL Homepage + flathub https://dl.flathub.org/repo/ https://flathub.org/ + ``` - If Flathub is not among the remotes shown, this command will add it to your - system: + If Flathub is not among the remotes shown, this command will add it to your + system: - ```sh - sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo - ``` + ``` shell + sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo + ``` 1. Finally, install the RetroArch Flatpak. You have the option of making it available to only the current user, with this command: - ```sh - flatpak install -y --user --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref - ``` + ``` shell + flatpak install -y --user --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref + ``` - Or for all users with this command: + Or for all users with this command: - ```sh - sudo flatpak install -y --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref - ``` + ``` shell + sudo flatpak install -y --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref + ``` -#### Launching the Flatpak +### Launching the Flatpak RetroArch should now be listed in your app launcher and can also be executed from the terminal with the command: -```sh +``` shell flatpak run org.libretro.RetroArch ``` -#### Updates +### Updates You should keep RetroArch updated by running this command periodically from the terminal: -```sh +``` shell flatpak update -y --app org.libretro.RetroArch ``` -### Ubuntu-based +## Ubuntu(-based) -If you're using Ubuntu, an official [Ubuntu flavor][ubuntu-flavors], or one of -the many Linux distributions based on Ubuntu (such as Linux Mint, Zorin OS, Pop! -OS, elementary OS, etc.), you can install RetroArch and many of the most popular -Libretro cores as native APT packages by simply enabling one (or both) of the -two official Libretro [Personal Package Archives (PPAs)][help-ppas] hosted on -[Launchpad](https://launchpad.net/~libretro), namely: +Ubuntu provides RetroArch as a Debian [package in their official "universe" +archive][ubuntu-package], which is maintained by the community with no promise +of support or regular update schedule. Nevertheless, for the casual user of +Ubuntu or a derivative distribution, it represents the simplest method for +installing RetroArch. All that is required is to open a terminal and issue this +single command: -- [**Stable**][ppa-stable] (recommended), which includes only official releases - (as announced on libretro.com / retroarch.com), and -- [**Testing**][ppa-testing], which provides nightly builds of RetroArch and - most Libretro cores that allow you to test new features as soon as they're - added. +``` shell +sudo apt --upgrade --yes install retroarch +``` -#### Installation +### Personal Package Archives (PPAs) -In order to add PPAs to your system's package sources, some tools from the -official package repositories are needed. Open the terminal and run this command -to ensure they are installed: +In an effort to improve the experience of RetroArch users on Ubuntu, official +[Ubuntu flavors][ubuntu-flavors], and all of the many Linux distributions based +on Ubuntu (such as Linux Mint, Zorin OS, Pop! OS, elementary OS, etc.), the +Libretro Team has long been committed to producing its own Debian packages as an +alternative to the ones supplied by Ubuntu in the "universe" package archive. +These packages are updated much faster to keep pace with each new RetroArch +version, and compiled with a greater range of features than the Ubuntu package. +In addition, Debian packages are created for the vast majority of popular +Libretro cores, simplifying their installation and allowing them to be updated +by the system package manager on the same schedule as all other package updates. -```sh -sudo apt -y install software-properties-common -``` +These packages are built and distributed using the [Launchpad +platform][launchpad-team] operated by Canonical itself (the company which +distributes Ubuntu), and split into two channels called "Personal Package +Archives" (PPAs) that each cater to a specific type of user. By simply [enabling +one (or both) the PPAs][help-ppas] listed below, users can seamlessly replace +the Ubuntu RetroArch package on their system with those provided by the Libretro +team. -One command is needed to add a PPA to your system's package sources. To add the -[**Stable PPA**][ppa-stable], use: +- [**Stable**][ppa-stable] (recommended) — includes only official releases + (as announced on libretro.com / retroarch.com) -```sh -sudo add-apt-repository -ysnP libretro/stable -``` +- [**Testing**][ppa-testing] — builds of RetroArch and most Libretro cores from + the latest source code, for test new fixes and features as soon as they're + added -Or to add the [**Testing PPA**][ppa-testing], use: +### Installation -```sh -sudo add-apt-repository -ysnP libretro/testing -``` +Follow these steps to enable the Libretro PPAs on your Ubuntu(-based) system. -You can now install the RetroArch package from the PPAs with this command: +1. In order to add PPAs to your system's package sources, some tools from the + official package repositories are needed. Open the terminal and run this + command to ensure they are installed: -```sh -sudo apt -Uy install retroarch -``` + ``` shell + sudo apt --update --yes install software-properties-common + ``` + +1. Just a single command is needed to add a PPA to your system's package + sources. + + - To add the [**Stable PPA**][ppa-stable], run this command in your + terminal: + + ``` shell + sudo add-apt-repository --yes --no-update --ppa libretro/stable + ``` + + - Or to add the [**Testing PPA**][ppa-testing], run: + + ``` shell + sudo add-apt-repository --yes --no-update --ppa libretro/testing + ``` + +1. You can now install the RetroArch package from the PPAs with this command: + + ``` shell + sudo apt --update --yes install retroarch + ``` + +#### Verifying PPA package installation -You can verify that the PPA package was installed rather than the one from the -official distribution repositories with the `apt show` command (shown with -expected output for the Testing PPA package): +You can verify that the PPA package is installed (rather than the one from the +official distribution repositories) with the `apt show retroarch` command (shown +with expected output for the Testing PPA package): -```console -$ apt show retroarch +``` shell-session hl_lines="14" +ra@libretro:~$ apt show retroarch Package: retroarch -Version: 1.19.1+r202408170734~bf25bd9149-179~ubuntu24.04.1 +Version: {{ unit.stable }}+r202408170734~bf25bd9149-179~ubuntu24.04.1 Priority: optional Section: games Maintainer: Libretro Team @@ -154,51 +192,91 @@ Description: Simple frontend for the libretro library Notice: There is 1 additional record. Please use the '-a' switch to see it ``` -Look at the **`APT-Sources:`** line in the output. If one of the PPA packages is -installed, its value will begin with -`https://ppa.launchpadcontent.net/libretro/`. +!!! tip "What to look for" + Look at the **`APT-Sources:`** line in the output. If one of the PPA + packages is installed, its value will begin with + `https://ppa.launchpadcontent.net/libretro/`. -#### Updates +### Updates With this installation method, RetroArch updates will automatically be included -with your systems regular package upgrades. However, you are always able to -trigger an update specifically for RetroArch with the terminal command: +with your system's regular package upgrades. However, you are always able to +trigger an update specifically for RetroArch (if one is available) with the +command: -```sh -sudo apt -y upgrade retroarch +``` shell +sudo apt --update --yes upgrade retroarch ``` -### Arch Linux-based +## Arch Linux(-based) -Arch Linux provides a [`retroarch`][arch-package] package for x86_64 systems in -their official [Extra repository][arch-extra-repo]. You can install it by +### Installation + +#### Official package + +Arch Linux provides a [**`retroarch`**][arch-package] package for x86_64 systems +in their official [Extra repository][arch-extra-repo]. You can install it by searching for RetroArch by name in a graphical package manager like [Octopi][octopi], or from the terminal with the command: -```sh +``` shell sudo pacman -S retroarch ``` -A "git" package named [`retroarch-git`][aur-git-package] which offers prerelease -builds (similar to the Testing PPA described above) is also available on the -[AUR][arch-aur]. As above, it can be installed from a package manager GUI or in -the terminal using an "[AUR helper][aur-helpers]" like [`yay`][aur-yay], as in: +#### Arch User Repository (AUR) package -```sh +A "git" package named [**`retroarch-git`**][aur-git-package] which offers +prerelease builds (similar to the Testing PPA described above) is also available +in the [AUR][arch-aur]. As above, it can be installed from a package manager GUI +or in the terminal using an "[AUR helper][aur-helpers]" like [`yay`][aur-yay], +as in: + +``` shell yay retroarch-git ``` +!!! tip "Installing an AUR helper" + If you wish to install the AUR package but don't yet have an AUR helper + installed on your system, the following shell "one-liner" will download, + compile and install `yay` for you: + + ``` shell + pacman -S --needed git base-devel && git clone https://aur.archlinux.org/yay-bin.git && + cd yay-bin && makepkg -si + ``` + +### Updates + +With this installation method, RetroArch updates will automatically be included +with your system's regular package upgrades. However, you are always able to +trigger an update specifically for RetroArch (if one is available) with the +following commands. + +#### Official package + +``` shell +pacman -Syyuu retroarch +``` + +#### AUR package + +``` shell +yay -Syyuu retroarch-git +``` + [arch-aur]: https://aur.archlinux.org/ "Arch User Repository (AUR)" -[arch-extra-repo]: https://wiki.archlinux.org/title/Official_repositories#extra -[arch-package]: https://archlinux.org/packages/extra/x86_64/retroarch/ -[aur-git-package]: https://aur.archlinux.org/packages/retroarch-git -[aur-helpers]: https://wiki.archlinux.org/title/AUR_helpers -[aur-yay]: https://github.com/Jguer/yay -[flatpak-remote]: https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak-remotes -[flatpak-setup]: https://flatpak.org/setup/ -[help-ppas]: https://help.launchpad.net/Packaging/PPA/InstallingSoftware -[octopi]: https://tintaescura.com/projects/octopi/ -[ppa-stable]: https://launchpad.net/~libretro/+archive/ubuntu/stable -[ppa-testing]: https://launchpad.net/~libretro/+archive/ubuntu/testing -[retroarch-flatpak]: https://flathub.org/apps/org.libretro.RetroArch -[ubuntu-flavors]: https://ubuntu.com/desktop/flavours +[arch-extra-repo]: https://wiki.archlinux.org/title/Official_repositories#extra "Official repositories - ArchWiki" +[arch-package]: https://archlinux.org/packages/extra/x86_64/retroarch/ "Arch Linux - retroarch {{ unit.stable }}-1 (x86_64)" +[aur-git-package]: https://aur.archlinux.org/packages/retroarch-git "AUR (en) - retroarch-git" +[aur-helpers]: https://wiki.archlinux.org/title/AUR_helpers "AUR helpers - ArchWiki" +[aur-yay]: https://github.com/Jguer/yay "Jguer/yay: Yet another Yogurt - An AUR Helper written in Go (GitHub)" +[flatpak-remote]: https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak-remotes "Flatpak Command Reference - Flatpak documentation" +[flatpak-setup]: https://flatpak.org/setup/ "Flatpak—the future of application distribution" +[help-ppas]: https://help.launchpad.net/Packaging/PPA/InstallingSoftware "Packaging/PPA/Installing Software - Launchpad Help" +[launchpad-team]: https://launchpad.net/~libretro "Libretro in Launchpad" +[octopi]: https://tintaescura.com/projects/octopi/ "Octopi - Tinta escura" +[ppa-stable]: https://launchpad.net/~libretro/+archive/ubuntu/stable "Libretro Stable : “Libretro” team" +[ppa-testing]: https://launchpad.net/~libretro/+archive/ubuntu/testing "Libretro Testing/Nightly : “Libretro” team" +[retroarch-flatpak]: https://flathub.org/apps/org.libretro.RetroArch "Install RetroArch on Linux | Flathub" +[ubuntu-flavors]: https://ubuntu.com/desktop/flavours "Ubuntu flavours | Ubuntu" +[ubuntu-package]: https://packages.ubuntu.com/search?keywords=retroarch&searchon=names "Ubuntu – Package Search Results -- retroarch" diff --git a/docs/guides/navigating.md.backup b/docs/guides/navigating.md.backup deleted file mode 100644 index 488331c914..0000000000 --- a/docs/guides/navigating.md.backup +++ /dev/null @@ -1,77 +0,0 @@ -# Navigating - -Navigating on RetroArch is as easy as you can imagine. Depending on the device you have, the control scheme is determined automatically. For example, if you are going to use it on a computer, the basic key combinations of the keyboard will apply. You move with the arrow keys and select with the *Enter* key, and you return with the *Backspace* key. If you plug a controller, you can also move with the D-Pad buttons. - -The default [GUI](GUI) for RetroArch is [Ozone](ozone.md). While the "skin" may differ on certain platforms, basic layout and navigation remains broadly the same. - -## PC - -By default the keyboard should be ready to use. - -Using the *left* and *right* arrow keys, you move to a different tab, each tab will relate to an aspect of the RetroArch experience (main menu for game loading, settings for settings etc.). Once the desired tab is selected, use the *up* and *down* arrow to move to an option. - -To advance in the menu press *Enter* (or *Return*). To go back to the previous menu push *Backspace*. - -Whilst in a game use the *F1* key to open the [Quick Menu](quick-menu.md). - -Pushing *Esc* twice will quit the program. - -### Main Menu - -![Ozone's Main Menu](../image/retroarch/ozone/first_run.webp) - -Welcome to the main menu. This is where you will launch games, download and update cores, and have access to freely available content. *Load Core*, *Load Content* and the *Online Updater* are the menu items you will probably be using the most. - -*See [Starting a Game](starting-a-game.md)* - -### Settings - -![Settings](../image/retroarch/ozone/settings.png) - -Here you will find all the options available to configure RetroArch, from Graphics, Input, Sound and everything else. - -### Favorites - -![Favorites](../image/retroarch/ozone/favorites.png) - -Favorites allow yous to maintain a short list of games for quick access. You can add content to this playlist from the [Quick Menu](quick-menu.md) or before launching it. - -### History - -![History](../image/retroarch/ozone/history.png) - -Recently launched content will be added to this Playlist. The content you ran last will be at the top. - -### Image, Music and Video - -These tabs will handle all your media. Images will contain any screenshots you've made. - -### Netplay - -RetroArch relies on peer-to-peer networking to reduce network latency and ensure the best possible experience. It allows multiplayer over the internet. The user can host or join a network gaming session, or use the Spectator mode to watch others play. RetroArch has a built-in netplay lobby. - -### Import content - -![import-content](../image/retroarch/ozone/import-content.png) - -Either you scan automatically, so that any content that matches the internal database will be added to Playlists, or you scan manually, not being dependent on the database so you can freely add your content to Playlists. - -## Mobile - -The mobile interface, [GLUI](glui.md), is much more minimalistic compared to the PC's interface. Touch is the default input, although depending on device other options may be available. There are three different tabs, which can be switched at the bottom of the menu. - -### Main Menu - -![GLUI's Main Menu](../image/retroarch/glui/glui-main.png) - -The main menu will be where you launch games, download and update cores, start or join netplay sessions and pretty much anything to do with gaming. - -*See [Starting a Game](starting-a-game.md)* - -### Playlists - -Handles anything to do with creating and maintaining playlists. It gives you scanning options to recognise your game collection. It also provides access to your images, music and videos. - -### Settings - -Here you will find all the options available to configure RetroArch, from Graphics, Input, Sound and everything else. diff --git a/docs/guides/rgui_wallpaper_template.svg b/docs/guides/rgui_wallpaper_template.svg index 7f8e6753b8..f08718ed14 100644 --- a/docs/guides/rgui_wallpaper_template.svg +++ b/docs/guides/rgui_wallpaper_template.svg @@ -1,95 +1,9 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - + + + + diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Cross.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Cross.png index 214b18b006..09f85e2ee1 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Cross.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Cross.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Diagonal.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Diagonal.png index a34dc6df44..fe7db08c36 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Diagonal.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Diagonal.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Full_Circle.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Full_Circle.png index 5ab50122ce..bfb8c51532 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Full_Circle.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Full_Circle.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Half_Circle.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Half_Circle.png index c799c49846..d0d9ee4bcb 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Half_Circle.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Half_Circle.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Horizontal.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Horizontal.png index 11bb993f84..8eeed3646c 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Horizontal.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Horizontal.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Quarter_Circle.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Quarter_Circle.png index b7da580dd9..498bb5d31d 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Quarter_Circle.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Quarter_Circle.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Sides.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Sides.png index 11bb993f84..52a11d3b7a 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Sides.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Sides.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Straight.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Straight.png index 68a375e9ce..4996f04e1e 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Straight.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Straight.png differ diff --git a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Vertical.png b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Vertical.png index 914a08368b..e4e33c30cd 100644 Binary files a/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Vertical.png and b/docs/image/Button_Pack/Directional_Arrows/Directional_Arrow_Vertical.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Double_Rotate.png b/docs/image/Button_Pack/Gestures/Gesture_Double_Rotate.png index f365a6e08c..1bfc14e5ef 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Double_Rotate.png and b/docs/image/Button_Pack/Gestures/Gesture_Double_Rotate.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Full_Circle.png b/docs/image/Button_Pack/Gestures/Gesture_Full_Circle.png index c8a46d4278..75cf4e9764 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Full_Circle.png and b/docs/image/Button_Pack/Gestures/Gesture_Full_Circle.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Half_Circle.png b/docs/image/Button_Pack/Gestures/Gesture_Half_Circle.png index 77ef7b4861..e9a7c31daf 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Half_Circle.png and b/docs/image/Button_Pack/Gestures/Gesture_Half_Circle.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Quarter_Circle.png b/docs/image/Button_Pack/Gestures/Gesture_Quarter_Circle.png index 56ecf95079..e7e893f654 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Quarter_Circle.png and b/docs/image/Button_Pack/Gestures/Gesture_Quarter_Circle.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Down.png b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Down.png index bd6092125f..247cff8a1f 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Down.png and b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Down.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Left.png b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Left.png index b4e14d3b1b..35c63c4ac4 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Left.png and b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Left.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Right.png b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Right.png index f9972d160c..729e393ba4 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Right.png and b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Right.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Up.png b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Up.png index 0de821de27..934e9aba88 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Scroll_Up.png and b/docs/image/Button_Pack/Gestures/Gesture_Scroll_Up.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Zoom_In.png b/docs/image/Button_Pack/Gestures/Gesture_Zoom_In.png index ef67afe5d5..f0a39d9b10 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Zoom_In.png and b/docs/image/Button_Pack/Gestures/Gesture_Zoom_In.png differ diff --git a/docs/image/Button_Pack/Gestures/Gesture_Zoom_Out.png b/docs/image/Button_Pack/Gestures/Gesture_Zoom_Out.png index edc117aadd..397d34555b 100644 Binary files a/docs/image/Button_Pack/Gestures/Gesture_Zoom_Out.png and b/docs/image/Button_Pack/Gestures/Gesture_Zoom_Out.png differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Circle.png b/docs/image/Button_Pack/PS _Move/PSMove_Circle.png deleted file mode 100644 index 10dd9b0351..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Circle.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Controller_Stick.png b/docs/image/Button_Pack/PS _Move/PSMove_Controller_Stick.png deleted file mode 100644 index 344a65f4e3..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Controller_Stick.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Controller_Wand.png b/docs/image/Button_Pack/PS _Move/PSMove_Controller_Wand.png deleted file mode 100644 index 0ed87c3226..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Controller_Wand.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Controllers.png b/docs/image/Button_Pack/PS _Move/PSMove_Controllers.png deleted file mode 100644 index 94c8c672d4..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Controllers.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Cross.png b/docs/image/Button_Pack/PS _Move/PSMove_Cross.png deleted file mode 100644 index 73a42a703f..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Cross.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_LT.png b/docs/image/Button_Pack/PS _Move/PSMove_LT.png deleted file mode 100644 index 05c0c8529f..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_LT.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Left_Stick.png b/docs/image/Button_Pack/PS _Move/PSMove_Left_Stick.png deleted file mode 100644 index 61b6330ade..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Left_Stick.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Move.png b/docs/image/Button_Pack/PS _Move/PSMove_Move.png deleted file mode 100644 index 25d1f8dcc8..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Move.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_RT.png b/docs/image/Button_Pack/PS _Move/PSMove_RT.png deleted file mode 100644 index c2a8470d6a..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_RT.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Select.png b/docs/image/Button_Pack/PS _Move/PSMove_Select.png deleted file mode 100644 index e83731c8b5..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Select.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Square.png b/docs/image/Button_Pack/PS _Move/PSMove_Square.png deleted file mode 100644 index 3ad12864be..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Square.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Start.png b/docs/image/Button_Pack/PS _Move/PSMove_Start.png deleted file mode 100644 index ba0ef2264a..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Start.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_T.png b/docs/image/Button_Pack/PS _Move/PSMove_T.png deleted file mode 100644 index a32a946030..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_T.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Triangle.png b/docs/image/Button_Pack/PS _Move/PSMove_Triangle.png deleted file mode 100644 index 9dcdbba8bc..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Triangle.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS _Move/PSMove_Trigger_Blank.png b/docs/image/Button_Pack/PS _Move/PSMove_Trigger_Blank.png deleted file mode 100644 index 30678a1a40..0000000000 Binary files a/docs/image/Button_Pack/PS _Move/PSMove_Trigger_Blank.png and /dev/null differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Circle.png b/docs/image/Button_Pack/PS_Move/PSMove_Circle.png new file mode 100644 index 0000000000..c9129bbe3d Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Circle.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Controller_Stick.png b/docs/image/Button_Pack/PS_Move/PSMove_Controller_Stick.png new file mode 100644 index 0000000000..45cf38e830 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Controller_Stick.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Controller_Wand.png b/docs/image/Button_Pack/PS_Move/PSMove_Controller_Wand.png new file mode 100644 index 0000000000..040e9d01e3 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Controller_Wand.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Controllers.png b/docs/image/Button_Pack/PS_Move/PSMove_Controllers.png new file mode 100644 index 0000000000..6d488a34b7 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Controllers.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Cross.png b/docs/image/Button_Pack/PS_Move/PSMove_Cross.png new file mode 100644 index 0000000000..08b616d4f7 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Cross.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_LT.png b/docs/image/Button_Pack/PS_Move/PSMove_LT.png new file mode 100644 index 0000000000..175f731624 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_LT.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Left_Stick.png b/docs/image/Button_Pack/PS_Move/PSMove_Left_Stick.png new file mode 100644 index 0000000000..b283739ae5 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Left_Stick.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Move.png b/docs/image/Button_Pack/PS_Move/PSMove_Move.png new file mode 100644 index 0000000000..a65cd368b2 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Move.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_RT.png b/docs/image/Button_Pack/PS_Move/PSMove_RT.png new file mode 100644 index 0000000000..8ac94a4072 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_RT.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Select.png b/docs/image/Button_Pack/PS_Move/PSMove_Select.png new file mode 100644 index 0000000000..8232209bbb Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Select.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Square.png b/docs/image/Button_Pack/PS_Move/PSMove_Square.png new file mode 100644 index 0000000000..f2b6a40c09 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Square.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Start.png b/docs/image/Button_Pack/PS_Move/PSMove_Start.png new file mode 100644 index 0000000000..4e294acf14 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Start.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_T.png b/docs/image/Button_Pack/PS_Move/PSMove_T.png new file mode 100644 index 0000000000..3ec4aa20d7 Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_T.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Triangle.png b/docs/image/Button_Pack/PS_Move/PSMove_Triangle.png new file mode 100644 index 0000000000..72121e915e Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Triangle.png differ diff --git a/docs/image/Button_Pack/PS_Move/PSMove_Trigger_Blank.png b/docs/image/Button_Pack/PS_Move/PSMove_Trigger_Blank.png new file mode 100644 index 0000000000..6317d82eff Binary files /dev/null and b/docs/image/Button_Pack/PS_Move/PSMove_Trigger_Blank.png differ diff --git a/docs/image/core/genesis_plus_gx/address_error.png b/docs/image/core/genesis_plus_gx/address_error.png index 18b925bea0..09bec05d5d 100644 Binary files a/docs/image/core/genesis_plus_gx/address_error.png and b/docs/image/core/genesis_plus_gx/address_error.png differ diff --git a/docs/image/core/genesis_plus_gx/bram.png b/docs/image/core/genesis_plus_gx/bram.png index 4c22ae9623..1867519faf 100644 Binary files a/docs/image/core/genesis_plus_gx/bram.png and b/docs/image/core/genesis_plus_gx/bram.png differ diff --git a/docs/image/core/genesis_plus_gx/composite.png b/docs/image/core/genesis_plus_gx/composite.png index b21ff44501..2d656ecfcf 100644 Binary files a/docs/image/core/genesis_plus_gx/composite.png and b/docs/image/core/genesis_plus_gx/composite.png differ diff --git a/docs/image/core/genesis_plus_gx/cue.png b/docs/image/core/genesis_plus_gx/cue.png index 13dc78a0c6..dab6fdae44 100644 Binary files a/docs/image/core/genesis_plus_gx/cue.png and b/docs/image/core/genesis_plus_gx/cue.png differ diff --git a/docs/image/core/genesis_plus_gx/m3u.png b/docs/image/core/genesis_plus_gx/m3u.png index e2a94456cf..b22476fe31 100644 Binary files a/docs/image/core/genesis_plus_gx/m3u.png and b/docs/image/core/genesis_plus_gx/m3u.png differ diff --git a/docs/image/core/genesis_plus_gx/vertical_disabled.png b/docs/image/core/genesis_plus_gx/vertical_disabled.png index 5f4314edba..ed14559dd4 100644 Binary files a/docs/image/core/genesis_plus_gx/vertical_disabled.png and b/docs/image/core/genesis_plus_gx/vertical_disabled.png differ diff --git a/docs/image/core/genesis_plus_gx/vertical_enabled.png b/docs/image/core/genesis_plus_gx/vertical_enabled.png index 5e5fd54c84..d0e393cf30 100644 Binary files a/docs/image/core/genesis_plus_gx/vertical_enabled.png and b/docs/image/core/genesis_plus_gx/vertical_enabled.png differ diff --git a/docs/image/core/jump_n_bump/jump-n-bump-flies-off.png b/docs/image/core/jump_n_bump/jump-n-bump-flies-off.png index a80255ae71..a0f3189deb 100644 Binary files a/docs/image/core/jump_n_bump/jump-n-bump-flies-off.png and b/docs/image/core/jump_n_bump/jump-n-bump-flies-off.png differ diff --git a/docs/image/core/jump_n_bump/jump-n-bump-flies-on.png b/docs/image/core/jump_n_bump/jump-n-bump-flies-on.png index ebca92fa44..934f0fa72c 100644 Binary files a/docs/image/core/jump_n_bump/jump-n-bump-flies-on.png and b/docs/image/core/jump_n_bump/jump-n-bump-flies-on.png differ diff --git a/docs/image/core/jump_n_bump/jump-n-bump-flip-level-off.png b/docs/image/core/jump_n_bump/jump-n-bump-flip-level-off.png index e5244f6fd0..8f11e4d295 100644 Binary files a/docs/image/core/jump_n_bump/jump-n-bump-flip-level-off.png and b/docs/image/core/jump_n_bump/jump-n-bump-flip-level-off.png differ diff --git a/docs/image/core/jump_n_bump/jump-n-bump-flip-level-on.png b/docs/image/core/jump_n_bump/jump-n-bump-flip-level-on.png index 57782c459e..e23c8ed056 100644 Binary files a/docs/image/core/jump_n_bump/jump-n-bump-flip-level-on.png and b/docs/image/core/jump_n_bump/jump-n-bump-flip-level-on.png differ diff --git a/docs/image/retroarch/altstore/screenshot1.png b/docs/image/retroarch/altstore/screenshot1.png index 01b1c6d92f..c7bc00aeba 100644 Binary files a/docs/image/retroarch/altstore/screenshot1.png and b/docs/image/retroarch/altstore/screenshot1.png differ diff --git a/docs/image/retroarch/altstore/screenshot2.png b/docs/image/retroarch/altstore/screenshot2.png index 230f6a079b..fbf6728bf4 100644 Binary files a/docs/image/retroarch/altstore/screenshot2.png and b/docs/image/retroarch/altstore/screenshot2.png differ diff --git a/docs/image/retroarch/altstore/screenshot3.png b/docs/image/retroarch/altstore/screenshot3.png index 4b2874dba2..ade2676dfa 100644 Binary files a/docs/image/retroarch/altstore/screenshot3.png and b/docs/image/retroarch/altstore/screenshot3.png differ diff --git a/docs/image/retroarch/altstore/screenshot4.png b/docs/image/retroarch/altstore/screenshot4.png index 5ee0eca724..42aa5f0ea9 100644 Binary files a/docs/image/retroarch/altstore/screenshot4.png and b/docs/image/retroarch/altstore/screenshot4.png differ diff --git a/docs/image/retroarch/altstore/screenshot5.png b/docs/image/retroarch/altstore/screenshot5.png index 4a939a4a17..e8c40960b8 100644 Binary files a/docs/image/retroarch/altstore/screenshot5.png and b/docs/image/retroarch/altstore/screenshot5.png differ diff --git a/docs/image/shader/motionblur/feedback.png b/docs/image/shader/motionblur/feedback.png index 2d129ee7d5..ec2dc343a7 100644 Binary files a/docs/image/shader/motionblur/feedback.png and b/docs/image/shader/motionblur/feedback.png differ diff --git a/docs/image/shader/motionblur/motionblur-simple.png b/docs/image/shader/motionblur/motionblur-simple.png index bf74741321..ab180650f3 100644 Binary files a/docs/image/shader/motionblur/motionblur-simple.png and b/docs/image/shader/motionblur/motionblur-simple.png differ diff --git a/docs/requirements.txt b/docs/requirements.txt index f2c29dd092..441bfa3403 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ mkdocs-macros-plugin -mkdocs-git-revision-date-plugin \ No newline at end of file +mkdocs-git-revision-date-plugin +pygments diff --git a/mkdocs.yml b/mkdocs.yml index 23e3c10df9..64001990a5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,12 +1,15 @@ +%YAML 1.2 +--- site_name: Libretro Docs site_url: 'https://docs.libretro.com/' -site_description: >- - This is RetroArch's document page, modification or development information outside of this repo may be incorrect. +site_description: >-2 + This is the official RetroArch documentation for users and developers. + Information from sources outside of this website may be dated or incorrect. repo_name: 'libretro/docs' repo_url: 'https://github.com/libretro/docs' edit_uri: 'edit/master/docs' -copyright: > - Copyright © 2010-2024 Libretro – +copyright: >2 + Copyright © 2010–2024 Libretro. – Change cookie settings nav: - 'About': 'index.md' @@ -48,12 +51,15 @@ nav: - 'User Guides': - 'User Interface': 'guides/navigating.md' - 'Input and Controls': 'guides/input-and-controls.md' + - 'Starting a Game': 'guides/starting-a-game.md' - 'Controller Auto-Configuration': 'guides/controller-autoconfiguration.md' - 'Installing Cores': 'guides/download-cores.md' - 'Core List': 'guides/core-list.md' - 'Directory Configuration': 'guides/change-directories.md' - 'File Browser': 'guides/file-browser.md' - 'Launching Content': 'guides/launch-content.md' + - 'Menu Styles': 'guides/gui.md' + - 'Quick Menu': 'guides/quick-menu.md' - 'Importing Content': 'guides/import-content.md' - 'Shaders': 'guides/shaders.md' - 'Overrides: Content/Folder/Core-Specific Settings': 'guides/overrides.md' @@ -66,6 +72,7 @@ nav: - 'Getting Started': 'guides/netplay-getting-started.md' - 'Multiple Controllers': 'guides/netplay-multiple-controllers.md' - 'RetroAchievements': 'guides/retroachievements.md' + - 'Disc Swapping': 'guides/disc-swapping.md' - 'Softpatching ROMs': 'guides/softpatching.md' - 'Accessibility': - 'Quick Start': 'guides/accessibility.md' @@ -75,10 +82,13 @@ nav: - 'Generating Logs': 'guides/generating-retroarch-logs.md' - 'RetroArch Cloud Sync (Apple Devices)': 'guides/retroarch-cloud-sync.md' - 'Appearance & Customization': + - 'Interface Styles': + - 'GLUI Interface': 'guides/glui.md' + - 'Ozone Interface': 'guides/ozone.md' + - 'RGUI Interface': 'guides/rgui.md' + - 'XMB Interface': 'guides/xmb.md' - 'Creating a Theme': 'guides/themes.md' - 'Playlists and Thumbnails': 'guides/roms-playlists-thumbnails.md' - - 'RGUI Interface': 'guides/rgui.md' - - 'Ozone Interface': 'guides/ozone.md' - 'XMB Menu Map': 'guides/xmb-menu-map.md' - 'Advanced': - 'AI Service': 'guides/ai-service.md' @@ -422,78 +432,50 @@ nav: - 'Privacy Policy': 'support/privacy-policy.md' - 'Quick informations': 'support/quick-informations.md' - 'Developing Cores': 'tech/developing-cores.md' + extra: + adsense: "ca-pub-9447404270680650" + analytics: + provider: google + property: G-MT11L3F6EZ consent: - title: Cookie consent - description: >- + description: >-2 We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. - version: '0.1.0' - adsense: "ca-pub-9447404270680650" + title: Cookie consent font: - text: 'Roboto' - code: 'Roboto Mono' + text: 'Noto Sans' + code: 'Noto Sans Mono' i18n: prev: 'Previous' next: 'Next' social: - icon: fontawesome/brands/github-alt link: https://github.com/libretro - - icon: fontawesome/brands/twitter - link: https://twitter.com/libretro + name: Libretro on GitHub + - icon: fontawesome/brands/x-twitter + link: https://x.com/libretro + name: Libretro on X + - icon: fontawesome/brands/discord + link: https://discord.gg/C4amCeV + name: RetroArch Discord server + - icon: fontawesome/brands/youtube + link: https://www.youtube.com/@Libretro + name: Libretro YouTube channel - icon: fontawesome/brands/facebook link: https://facebook.com/libretro - - icon: fontawesome/brands/youtube - link: https://youtube.com/libretro - analytics: - provider: google - property: G-MT11L3F6EZ - - -theme: - name: material - custom_dir: docs/overrides/ - palette: - - scheme: retroarch - toggle: - icon: material/weather-sunny - name: Switch to light mode - - scheme: slate - toggle: - icon: material/weather-night - name: Switch to dark mode - primary: black - accent: deep purple - # 404 page - static_templates: - - 404.html - # Don't include MkDocs' JavaScript - include_search_page: false - search_index_only: true - # Default values, taken from mkdocs_theme.yml - language: en - features: - - navigation.tabs - - navigation.top - - tables - - content.code.annotate - - content.action.edit - font: - text: Roboto - code: Roboto Mono - logo: 'image/branding/invader.png' - favicon: 'image/branding/invader.png' - -plugins: - - search - - git-revision-date - - macros - -extra: + name: Libretro on Facebook + - icon: fontawesome/brands/instagram + link: https://www.instagram.com/libretro + name: Libretro/RetroArch on Instagram + status: + fixed: The information on this page never changes + stable: The information on this page changes infrequently, or not at all unit: stable: 1.19.1 + version: '0.2.0' extra_css: - stylesheets/extra.css @@ -504,40 +486,102 @@ markdown_extensions: - attr_list - def_list - footnotes - - meta - md_in_html - - markdown.extensions.admonition - - markdown.extensions.codehilite: - linenums: true - guess_lang: false - - markdown.extensions.nl2br - - markdown.extensions.toc: - permalink: true + - meta - pymdownx.arithmatex - pymdownx.betterem: smart_enable: all - - pymdownx.caret + - pymdownx.caret: + insert: true + smart_insert: true + superscript: true - pymdownx.critic: mode: accept - pymdownx.details - - pymdownx.highlight - # linenums_style: pymdownx-inline - - pymdownx.inlinehilite - - pymdownx.keys + - pymdownx.emoji: + emoji_generator: !!python/name:material.extensions.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + - pymdownx.highlight: + anchor_linenums: true + auto_title: false + guess_lang: block + line_spans: __span + linenums: false + linenums_style: pymdownx-inline + pygments_lang_class: true + stripnl: false + use_pygments: true + - pymdownx.inlinehilite: + style_plain_text: true + - pymdownx.keys: + camel_case: true + strict: true - pymdownx.magiclink: + repo: docs repo_url_shorthand: true user: libretro - repo: docs - - pymdownx.mark - - pymdownx.smartsymbols + - pymdownx.mark: + smart_mark: true + - pymdownx.smartsymbols: + arrows: false - pymdownx.snippets: check_paths: true + dedent_subsections: true - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - - pymdownx.tabbed + - pymdownx.tabbed: + alternate_style: true + combine_header_slug: true - pymdownx.tasklist: + clickable_checkbox: false custom_checkbox: true - - pymdownx.tilde + - pymdownx.tilde: + delete: true + smart_delete: true + subscript: true + - toc: + permalink: true + permalink_title: Reference link to this section + toc_depth: 6 + +plugins: + - git-revision-date + - macros + - search + +theme: + custom_dir: docs/overrides/ + favicon: 'image/branding/invader.png' + features: + - content.action.edit + - content.code.annotate + - content.code.copy + - navigation.tabs + - navigation.top + - tables + font: + text: 'Noto Sans' + code: 'Noto Sans Mono' + # Don't include MkDocs' JavaScript + include_search_page: false + language: en + logo: 'image/branding/invader.png' + name: material + palette: + - scheme: retroarch + toggle: + icon: material/weather-sunny + name: Switch to light mode + - scheme: slate + accent: deep purple + primary: black + toggle: + icon: material/weather-night + name: Switch to dark mode + search_index_only: true + static_templates: + - 404.html +...