Skip to main content

Contributing to the Guides

You can contribute to the guides by creating a fork of the plugin repository, or by editing the file directly on Github, or you can download the wiki branch of the repository and send me back your files the way you want.

Workflow​

  1. [ONLY ONCE] Create a fork of the plugin's repository.

  2. Clone locally only the wiki branch of your forked repository by using this command:

git clone https://github.com/YourGithubUserName/ProceduralDungeon.git --branch wiki --single-branch

  1. Make the changes you want in the pages as described in the next section.

  2. Create a commit of your changes. It is best practice to create as much possible atomic commits.
    For example, split in 2 commits if you have added a paragraph in a file, and also corrected the orthograph in another.

  3. Push your commits into your forked repository.

  4. Create a pull request from your wiki branch (compare branch) into my wiki branch (base branch).

Modifying the pages​

Documentation pages are written in Markdown, a language created to be readable even in plain-text editors but also carrying all necessary information to generate basic but efficient html pages.

Recommendation

Even though the files are easily readable in plain-text editors like the Windows Notepad, I strongly recommend you to use an editor supporting Markdown and capable of previewing it in real-time.
I am personally using Visual Studio Code with the extensions:

I bet you already know some basic syntax, since it is used nowadays in most social networks and messaging apps we use everyday (e.g. Discord, Github, Telegram, Stack Overflow, Reddit, Slack, etc.).

Basic Markdown formatting​

Those basic formatting syntax is what is commonly known by people:

*italic text*
**bold text**
***bold and italic text***

There are headings too :

# Page title

## Section title

### Sub section title

#### At this point this is mostly just bold text

You control how the lines break using the \ at the end of line:

Those 2 lines are
displayed on the same line.

You can do a simple line break\
to display one paragraph on multiple lines.

You can create multiple paragraphs by

putting an empty line between them.

You can create ordered and unordered lists:

1. This
2. is an
3. ordered list

- This
- is an
- unordered list

You can create links to other pages or external websites:

[This is a link to the Installation page](Installation)

[This is a link to the plugin repository](https://github.com/BenPyton/ProceduralDungeon)

You can create block of codes:

You can insert an `inline block of code` using backticks around it.

```cpp
void SomeCppCode()
{
    // on multiline
}
```

```txt title="Console Prompt"
Code block with a title to add context.
```

You can embed images:

![Alt Text](Images/MyImage.png)

You can add footnotes:

A footnote [^1].

[^1]: Footnote description.

You can create tables:

|  ID |  Name | Description |
| --- | ----- | ----------- |
|   0 |  Base | This is a table row |
|   2 | Other | Another row in the table |

Features added by Docusaurus​

You can add some admonitions (note, info, tip, warning, danger):

:::note

This is a note

:::

:::warning[Be Careful]

A warning with a custom title

:::

You can create tabs:

<Tabs>
<TabItem value="id1" label="First Tab" default>

The content of the first tab

</TabItem>
<TabItem value="id2" label="Second Tab">

The content of the second tab

</TabItem>
</Tabs>

There are some metadata at the very beginning of the file called FrontMatter.
Except in rare cases, you must not modify them.

---
slug: examples/something
id: something
---