|
1 | 1 | # Contributing to documentation |
2 | 2 |
|
3 | 3 | You would like to contribute to the documentation site? Great! |
4 | | -We use [MkDocs](https://www.mkdocs.org/) and [Github pages](https://pages.github.com/) for the documentation site you're reading right now. |
| 4 | +We use [MkDocs](https://www.mkdocs.org/) and [GitHub pages](https://pages.github.com/) for the documentation site you're reading right now. |
5 | 5 |
|
6 | 6 | Here is a step-by-step guide on how to create/edit pages. |
7 | 7 |
|
@@ -45,7 +45,7 @@ If Python is not installed, you can download it from the [official Python downlo |
45 | 45 | !!! note "For Windows users" |
46 | 46 | During installation, make sure to check the box that says "Add Python to PATH" if the installer offers such an option (it's usually off by default). |
47 | 47 |
|
48 | | -  |
| 48 | +  |
49 | 49 |
|
50 | 50 | ### Text Editor (Optional) |
51 | 51 |
|
@@ -73,15 +73,15 @@ We recommend [Visual Studio Code (VS Code)](https://code.visualstudio.com/), a f |
73 | 73 | Now head over to the [pylon-docs repository](https://github.com/pylonmc/pylon-docs). |
74 | 74 | Click the "Fork" button in the top-right corner of the page to create your own copy of the repository. |
75 | 75 |
|
76 | | - |
| 76 | + |
77 | 77 |
|
78 | 78 | ## Step 2: Cloning your fork |
79 | 79 |
|
80 | 80 | You will need to clone your forked repository to your local machine to be able to preview the changes. |
81 | 81 |
|
82 | 82 | First, go to your forked repository on GitHub, click on the green "Code" button, and copy the URL under "HTTPS". |
83 | 83 |
|
84 | | - |
| 84 | + |
85 | 85 |
|
86 | 86 | Open your terminal and run the following command (replace `<CLONE_URL_HERE>` with the URL you just copied): |
87 | 87 |
|
@@ -188,17 +188,17 @@ If the `img/` folder doesn't exist in that directory, create it first. |
188 | 188 | To embed an image in your markdown file, use the following syntax: |
189 | 189 |
|
190 | 190 | ```markdown |
191 | | - |
| 191 | + |
192 | 192 | ``` |
193 | 193 |
|
194 | 194 | - Replace `Image description` with a short description of what the image shows |
195 | 195 | - Replace `your-image-name.png` with your actual filename |
196 | | -- The `./img/` path is relative to your current markdown file |
| 196 | +- The `img/` path is relative to your current markdown file |
197 | 197 |
|
198 | 198 | **Example:** |
199 | 199 |
|
200 | 200 | ```markdown |
201 | | - |
| 201 | + |
202 | 202 | ``` |
203 | 203 |
|
204 | 204 | ## Step 5: Previewing your changes |
@@ -236,9 +236,9 @@ Once you pushed your changes to your fork on GitHub, you can create a pull reque |
236 | 236 |
|
237 | 237 | 1. Go to your forked repository on GitHub. You can always find your fork on GitHub's dashboard or your profile page. |
238 | 238 | 2. Click on the "Pull requests" tab. |
239 | | - |
| 239 | + |
240 | 240 | 3. Click on the green "New pull request" button. |
241 | | -4. Fill the title and description for your pull request. |
| 241 | +4. Fill in the title and description for your pull request. |
242 | 242 | 5. Click "Create pull request". |
243 | 243 |
|
244 | 244 | That's it! Your changes will be reviewed by the maintainers. If everything looks good, your contribution will be merged. 🎉 |
|
0 commit comments