docs: move to mkdocs

TGRHavoc · Oct 21, 2021 · b0eafa7 · b0eafa7
1 parent dc47822
commit b0eafa7
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 39 deletions.
diff --git a/.versionrc b/.versionrc
@@ -1,5 +1,5 @@
 {
-    "header": "---\nlayout: default\ntitle: Changelog\nnav_order: 9999\nparent: LiveMap Resource\n---\n# Changelog\n",
+    "header": "# Changelog\n",
     "commit-all": true,
     "releaseCommitMessageFormat": "chore(release): v{{currentTag}}",
     "infile": "docs/CHANGELOG.md",

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,9 +1,3 @@
----
-layout: default
-title: Changelog
-nav_order: 9999
-parent: LiveMap Resource
----
 # Changelog
 
 ## [3.2.0](https://github.com/TGRHavoc/live_map/compare/v3.1.4...v3.2.0) (2021-10-20)

diff --git a/docs/README.md b/docs/README.md
@@ -1,10 +1,3 @@
----
-layout: default
-title: LiveMap Resource
-has_children: true
-permalink: /livemap-resource
----
-
 # LiveMap Resource (for FiveM) <!-- omit in toc -->
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)

diff --git a/docs/config.md b/docs/config.md
@@ -1,10 +1,4 @@
----
-layout: default
-title: Configuration
-nav_order: 1
-parent: LiveMap Resource
----
-
+# Configuring the resource
 ## Convars
 The following convars are available for you to change.
 
@@ -78,7 +72,8 @@ Sets the domain that is allowed to access the blips.json file.
 
 E.g. "https://example.com" will only allow the UI on http://example.com to get the blips), "*" will allow everyone no matter the domain.
 
-> **Note**: Only use "*" if you don't mind _anyone_ being able to access your
-> player's data and your blip data.
-> It is recommended that you set this to your own website.
-{: .fs-3}
+!!! info "Note"
+
+    Only use "*" if you don't mind _anyone_ being able to access your
+    player's data and your blip data.
+    It is recommended that you set this to your own website.
diff --git a/docs/events.md b/docs/events.md
@@ -1,10 +1,3 @@
----
-layout: default
-title: Events
-nav_order: 2
-parent: LiveMap Resource
----
-
 # Events / API <!-- omit in toc -->
 
 - [Client to server](#client-to-server)

diff --git a/docs/license.md b/docs/license.md
@@ -1,10 +1,3 @@
----
-layout: default
-title: License
-nav_exclude: true
-parent: LiveMap Resource
----
-
 GNU General Public License
 ==========================
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,8 @@
+site_name: livemap_resource
+
+nav:
+  - 'README.md'
+  - Configurtion: "config.md"
+  - Events: "events.md"
+  - Changelog: 'CHANGELOG.md'
+  - License: "license.md"