mirror of
https://github.com/BeamMP/Docs.git
synced 2026-10-26 06:00:24 +00:00
Deployed ec3dcdb with MkDocs version: 1.6.1
This commit is contained in:
committed
commit
4bd4719a4a
751 files changed
+1175717
No files matched your search
@@ -0,0 +1 @@
|
||||
{"config":{"lang":["en","es","de","fr","it","ru","zh"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Home","text":"<p>This site is under construction!</p> <p>This site is being actively worked on. </p> <p>Feel you could help? Please do by clicking on the page with a pencil on the right!</p> <p>This can be done on any page, too.</p>"},{"location":"#welcome-to-beammp-docs","title":"Welcome to BeamMP Docs!","text":"<p>Welcome to the new and improved documentation hub for BeamMP! Whether you're a player, server owner, or developer, we have the resources you need to enhance your BeamNG.drive multiplayer experience.</p>"},{"location":"#for-players","title":"For Players","text":"<p>New to BeamMP? Check out our Getting Started page to help you hit the road running and make the most out of your multiplayer adventures. For general questions and issues please check out the Players FAQ.</p>"},{"location":"#for-server-owners","title":"For Server Owners","text":"<p>Thinking about creating your own BeamMP server? Our comprehensive guide here will walk you through the process, ensuring you have all the tools and knowledge to set up your server efficiently.</p>"},{"location":"#for-developers","title":"For Developers","text":"<p>Discover the ins and outs of creating resources for the BeamMP Server in our Resource Development Guide.</p> <p>Exciting updates are on the horizon, including a brand-new homepage designed to enhance your browsing experience. Stay tuned for more! </p>"},{"location":"#community-rules","title":"Community Rules","text":"<p>Read through the BeamMP Community rules and how to appeal bans.</p>"},{"location":"contributing/","title":"Contributing to the BeamMP Docs","text":"<p>BeamMP is using Material for MkDocs as its theme. This is a theme for MkDocs. Full documentation can be found at their respective sites.</p>"},{"location":"contributing/#getting-started","title":"Getting Started","text":"<p>To help contribute to these docs you can take one of two approaches as set out below:</p>"},{"location":"contributing/#1-edit-the-raw-markdown-files","title":"1. Edit the raw markdown files","text":"<p>Editing the raw markdown files is the fastest approach and best for quick edits such as spelling, grammar or new snippets of content. This approach does require a prior knowledge of markdown however as you will need to understand what your contribution will produce.</p> <p>If this is the approach you wish to take then please follow these steps:</p> <ol> <li>Click edit on the page you wish to edit.</li> <li>Fork the project into your own GitHub account.</li> <li>Make the changes you see fit.</li> <li>Commit your changes to your fork.</li> <li>Raise a pull request against our repository here.</li> </ol> <p>Once you have created your pull request one of the BeamMP Mod Team will review your Pull Request and either approve it or request some changes. If changes were requested and you have completed them we will re-review your Pull Request. Then your changes will be merged into the repository and automatically deployed as part of our continuous integration.</p>"},{"location":"contributing/#2-make-edits-with-live-preview","title":"2. Make edits with live preview","text":"<p>Editing our docs this way will still take a similar approach as in option 1 however you will be able to preview your changes this way.</p> <ol> <li>Click edit on the page you wish to edit.</li> <li>Fork the project into your own GitHub account.</li> <li>Clone the project locally.</li> <li>Setup Material for MkDocs according to their guide here</li> <li>Run <code>mkdocs serve</code> to start the live-reloading docs server from where you cloned the fork to.</li> <li>Make the changes that you see fit.</li> <li>Commit your changes to your fork.</li> <li>Raise a pull request against our repository here.</li> </ol>"},{"location":"contributing/#project-layout","title":"Project layout","text":"<pre><code>mkdocs.yml # The configuration file.\ndocs/\n index.md # The documentation homepage.\n ... # Other markdown pages, images and other files.\n</code></pre>"},{"location":"API%20documentation/Client-Side/","title":"Client Side","text":""},{"location":"API%20documentation/Client-Side/#table-of-contents","title":"Table of Contents","text":""},{"location":"API%20documentation/Client-Side/#mpvehiclege","title":"MPVehicleGE","text":"<ul> <li>Vehicle Functions</li> <li>Player Functions</li> <li>Nametag Functions</li> <li>Role Functions</li> <li>Navigation Functions</li> <li>Object Methods</li> <li>Event Hooks</li> </ul>"},{"location":"API%20documentation/Client-Side/#mpconfig","title":"MPConfig","text":"<ul> <li>MPConfig Functions</li> </ul>"},{"location":"API%20documentation/Client-Side/#mpcorenetwork","title":"MPCoreNetwork","text":"<ul> <li>MPCoreNetwork Functions</li> </ul>"},{"location":"API%20documentation/Client-Side/#mpgamenLine truncated
|
||||
Reference in new issue
Block a user