> For the complete documentation index, see [llms.txt](https://docs.arkannis.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.arkannis.net/devops/git/git-markdown.md).

# Git Markdown

## This file is used to get an idea on how to write text on Github

**Good resource for -->** [**Click here**](https://guides.github.com/features/mastering-markdown/)

### Writing Text on Github:

## heading 1 --> converted to

## in html

### heading 2

#### heading 3

**heading 4**

**heading 5**

**heading 6**

Normal Text

**Bold Text**

*Italic Text*

~~strikthrough Text~~

### Writing lists on Github:

#### Unordered lists:

* item 1
* item 2
  * sub item 2b

#### Ordered lists:

1. item 1
2. item 2
3. item 3

#### Item Completion list:

* [ ] \[] item 1 incomplete
* [x] item 2 complete

#### Linking itmes:

[TextThatYouWantToApper](https://link-to-what-you-want.com)

#### Displaying images:

In brackets you would put the local path to the image or the URL:

![TextThatYouWantToApper](https://link-to-image.com)

#### Code Blocks:

| column 1 | column 2 |
| -------- | -------: |
| row1a    |    row2a |

Note: To left align column :--- To right align column ---:

This is `console.log()`

or:

```
console.log()
```

With above you can mark the language

```python
console.log()
```

**Code Block Highlighting:**

Basic example:

Before:

```python
const_data = []
```

After:

```python
const_data = {}
```

Better way of doing thigs:

```diff
- const_data = []
+ const_data = {}
```

#### Quotes:

> Idea 1

Agree

> Idea 2

Disagree

**Closing an issue when the pull request gets merged**

closes #3543534 - Number of the issue fixes #34435 - Number of the issue


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.arkannis.net/devops/git/git-markdown.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.