Skip to content

Commit

Permalink
Convert reStructuredText to Markdown (#2)
Browse files Browse the repository at this point in the history
Converts the reStructuredText syntax to Markdown with an effort to keep the diff as minimal as possible in the process.

Co-authored-by: Cazdotsys <[email protected]>
  • Loading branch information
GeckoEidechse and Caznix authored Sep 19, 2024
1 parent 683200b commit bc25c01
Show file tree
Hide file tree
Showing 128 changed files with 5,320 additions and 90,801 deletions.
5 changes: 0 additions & 5 deletions docs/Modding/api.md

This file was deleted.

66 changes: 0 additions & 66 deletions docs/Modding/conf.py

This file was deleted.

56 changes: 27 additions & 29 deletions docs/Modding/guides/contributing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Contributing to ModdingDocs
===========================
# Contributing to ModdingDocs

**How can I contribute?**

Expand All @@ -12,62 +11,61 @@ Including:

**What do I need to know to contribute?**

ModdingDocs uses `reStructuredText <https://en.wikipedia.org/wiki/ReStructuredText>`_.
ModdingDocs uses [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText).

Cheatsheet for reStructuredText syntax: https://docs.generic-mapping-tools.org/6.2/rst-cheatsheet.html.

The ``.rst`` files can be found in the ``docs/source`` directory. If you're adding a new file, make sure to link it in ``index.rst``

Contributing without a local build
----------------------------------
## Contributing without a local build

You don't necessarily need to set up a local build environment.

To contribute without doing so, you can just edit the files in an editor of your choice and create a GitHub pull request from them.

There will be a test-build done for each PR, which you can find on your PR as a "Check" by clicking ``show all checks`` and ``details``.

This should take you to a online version of the docs with your PRs changes.
This should take you to a online version of the docs with your PRs changes.


## Building locally

Building locally
----------------
You need to have a relatively recent version of Python installed - 3.8 or higher. [Download here](https://www.python.org/downloads/)

You need to have a relatively recent version of Python installed - 3.8 or higher. `Download here <https://www.python.org/downloads/>`_

.. tab-set::

.. tab-item:: Windows
=== "Windows"

.. code-block:: powershell
```powershell

git clone https://github.com/R2Northstar/ModdingDocs/
cd ModdingDocs
./run.ps1

.. tab-item:: Linux
git clone https://github.com/R2Northstar/ModdingDocs/
cd ModdingDocs
./run.ps1
```

.. code-block:: bash
=== "Linux"

git clone https://github.com/R2Northstar/ModdingDocs/
cd ModdingDocs
./run.sh
```bash

.. warning::
git clone https://github.com/R2Northstar/ModdingDocs/
cd ModdingDocs
./run.sh
```

!!! warning
On Windows, if you are not able to run the script by running `./run.ps1`, try running it with: `powershell.exe -ExecutionPolicy Bypass -File .\run.ps1`

After this you should be able to run with just `./run.ps1`.


VSCode
---------------

If you're using `Visual Studio Code <https://code.visualstudio.com/>`_, the following extensions might be of interest:
## VSCode

If you're using [Visual Studio Code](https://code.visualstudio.com/), the following extensions might be of interest:

- `snekvik.simple-rst <https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst>`_: for syntax highlighting
- `lextudio.restructuredtext <https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext>`_: for autocompletion and syntax checks.
- [snekvik.simple-rst](https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst): for syntax highlighting
- [lextudio.restructuredtext](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext): for autocompletion and syntax checks.

.. note::
!!! note
To get the ReStructuredText support working, you will likely need to tell VSCode to use the Poetry environment.

To do so, open one of the .py files, which should make the python version appear in the bottom right of VSCode.
Expand Down
Loading

0 comments on commit bc25c01

Please sign in to comment.