From 47ce38f5b793eaa8fffed880010f23a65273aa85 Mon Sep 17 00:00:00 2001 From: Starystars67 Date: Thu, 28 Dec 2023 17:39:52 +0000 Subject: [PATCH 1/2] Update README.md to include step to install needed plugins --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bae33d2b..feab0433 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,11 @@ Editing our docs this way will still take a similar approach as in option 1 howe 2. Fork the project into your own GitHub account. 3. Clone the project locally. 4. Setup Material for MkDocs according to their guide [here](https://squidfunk.github.io/mkdocs-material/getting-started/) -5. Run `mkdocs serve` to start the live-reloading docs server from where you cloned the fork to. -6. Make the changes that you see fit. -7. Commit your changes to your fork. -8. Raise a pull request against our repository [here](https://github.com/BeamMP/Docs). +5. Install the required plugins using the following command: `pip install mkdocs-material mkdocs-git-revision-date-localized-plugin "mkdocs-material[imaging]" mkdocs-static-i18n[material]` +6. Run `mkdocs serve` to start the live-reloading docs server from where you cloned the fork to. +7. Make the changes that you see fit. +8. Commit your changes to your fork. +9. Raise a pull request against our repository [here](https://github.com/BeamMP/Docs). ## Project layout From 342de86c74584e8d69f23fef487e129fa08a0146 Mon Sep 17 00:00:00 2001 From: Starystars67 Date: Thu, 28 Dec 2023 17:41:41 +0000 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index feab0433..b06933c0 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Welcome to the BeamMP Docs GitHub Repository. We are glad you are here because t # Contributing to the BeamMP Docs BeamMP is using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) as its theme. This is a theme for [MkDocs](https://www.mkdocs.org). -Full documentation can be found at their respective sites.cs.org). +Full documentation can be found at their respective sites. ## Getting Started