BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2025-07-01 15:35:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md to include step to install needed plugins

Browse Source
This commit is contained in:
Starystars67 2023-12-28 17:39:52 +00:00 committed by GitHub
parent a916af737b
commit 47ce38f5b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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. 2. Fork the project into your own GitHub account.
3. Clone the project locally. 3. Clone the project locally.
4. Setup Material for MkDocs according to their guide [here](https://squidfunk.github.io/mkdocs-material/getting-started/) 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. 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. Make the changes that you see fit. 6. Run `mkdocs serve` to start the live-reloading docs server from where you cloned the fork to.
7. Commit your changes to your fork. 7. Make the changes that you see fit.
8. Raise a pull request against our repository [here](https://github.com/BeamMP/Docs). 8. Commit your changes to your fork.
9. Raise a pull request against our repository [here](https://github.com/BeamMP/Docs).
## Project layout ## Project layout