# Pre-Commit Test File

Testing `mdformat-mkdocs` as a `pre-commit` hook (`tox -e py#-hook`)

# Table

| Label | Rating | Comment          |
| :---- | -----: | :--------------- |
| Name  |      2 | <!-- Comment --> |

## Floating Link

> Based on [External Link]

______________________________________________________________________

## Arbitrary Markdown thanks to `czuli/github-markdown-example`

### **Typo**

# \[h1\] The largest heading

## \[h2\] heading

### \[h3\] heading

#### \[h4\] heading

##### \[h5\] heading

###### \[h6\] The smallest heading

______________________________________________________________________

### Bold

**This is bold text**

______________________________________________________________________

### Italic

*This text is italicized*

______________________________________________________________________

### Strikethrough

~~This was mistaken text~~

______________________________________________________________________

### Bold and nested italic

**This text is _extremely_ important**

______________________________________________________________________

### All bold and italic

***All this text is important***

______________________________________________________________________

### Subscript

<sub>This is a subscript text</sub>

______________________________________________________________________

### Superscript

<sup>This is a superscript text</sup>

______________________________________________________________________

### Quote

Text that is not a quote

> Text that is a quote
> Text that is a quote
> Text that is a quote

______________________________________________________________________

### Quoting code

Use `git status` to list all new or modified files that haven't yet been committed.

#### Code without highlighting

Some basic Git commands are:

```sh
git status
git add
git commit
```

#### Syntax highlighting

#### ruby code

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

#### bash code

```bash
# image
FROM php:7.1-apache

# envs
ENV INSTALL_DIR /var/www/html

# install composer
RUN curl -sS https://getcomposer.org/installer | php \
&& mv composer.phar /usr/local/bin/composer

# install libraries
RUN requirements="cron libpng-dev libmcrypt-dev libmcrypt4 libcurl3-dev libfreetype6 libjpeg62-turbo libjpeg62-turbo-dev libfreetype6-dev libicu-dev libxslt1-dev" \
 && apt-get update \
 && apt-get install -y $requirements \
 && rm -rf /var/lib/apt/lists/* \
 && docker-php-ext-install pdo_mysql \
 && docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/ \
 && docker-php-ext-install gd \
 && docker-php-ext-install mcrypt \
 && docker-php-ext-install mbstring \
 && docker-php-ext-install zip \
 && docker-php-ext-install intl \
 && docker-php-ext-install xsl \
 && docker-php-ext-install soap \
 && docker-php-ext-install bcmath

# add magento cron job
COPY ./crontab /etc/cron.d/magento2-cron
RUN chmod 0644 /etc/cron.d/magento2-cron
RUN crontab -u www-data /etc/cron.d/magento2-cron

# turn on mod_rewrite
RUN a2enmod rewrite

# set memory limits
RUN echo "memory_limit=2048M" > /usr/local/etc/php/conf.d/memory-limit.ini

# clean apt-get
RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

# www-data should own /var/www
RUN chown -R www-data:www-data /var/www

# switch user to www-data
USER www-data

# copy sources with proper user
COPY --chown=www-data . $INSTALL_DIR

# set working dir
WORKDIR $INSTALL_DIR

# composer install
RUN composer install
RUN composer config repositories.magento composer https://repo.magento.com/

# chmod directories
RUN chmod u+x bin/magento

# switch back
USER root

# run cron alongside apache
CMD [ "sh", "-c", "cron && apache2-foreground" ]
```

______________________________________________________________________

### Paragraphs

### Never store dependencies and compiled artifacts in the repository

- A repository with dependencies and artifacts is **growing very fast**. Git has not been designed to cope with large files, and the bigger the size of a file, the worse it performs
- If you store artifacts in the repository, you need to remember to compile the application before every commit, so you can commit the altered artifacts together with the changes to the source code. It's very risky because if you **forget to update the artifacts** in the repo, deploying your application to Production server may cause serious problems.
- The tasks that you use to compile, minimize and concatenate files may produce **different results**: it's enough that developers on your team use different versions of Node.js. Committing such files to the repository will incite constant conflicts that need to be solved manually. This makes branch merges very troublesome.
- An application compiled in version X of Node.js may **not work properly** in version Y – yet another human factor issue which makes it difficult to be 100% sure that the generated artifacts are compatible with the Node version on the Production server.

### Deploy has more steps

Okay, so now that we know keeping artifacts and dependencies in the repository is not a good idea, the question is: how *should* we deploy our application to the server? Without a Continuous Deployment tool, it usually looked like this:

1. The application is uploaded to the server via SFTP/SCP or Git and built with a script that will download the dependencies and run the tasks directly on the server
1. In case the SSH access is not available (eg. the server is FTP) the application must be built in a compatible environment before the deployment

______________________________________________________________________

### Links

This site was built using [GitHub Pages](https://pages.github.com/).

______________________________________________________________________

### Section links

[Contribution guidelines for this project](#table)

______________________________________________________________________

### Image

#### image from internet

![This is an image](https://buddy.works/assets/svg/brands/buddy.svg)

#### image from repo with link

[![](assets/buddy-podcast.png)](https://buddy.works)

______________________________________________________________________

### Specifying the theme an image is shown to

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/25423296/163456776-7f95b81a-f1ed-45f7-b7ab-8fa810d529fa.png">
  <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
  <img alt="Shows an illustrated sun in light color mode and a moon with stars in dark color mode." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>

______________________________________________________________________

### List

### Normal list

- George Washington
- John Adams
- Thomas Jefferson

### Ordered list

1. James Madison
1. James Monroe
1. John Quincy Adams

______________________________________________________________________

## TODO List

- [ ] Task item
    - [x] Completed Task item
        - [x] Another Completed Task item
- [ ] Task item
    - [ ] Task item
- [ ] Task item with code snippet `echo "hello world"`

## Mixed List

1. Prepare
    - Indented item
        - Further indented
            - [ ] Task
            - [ ] [Linked File](./fixtures.md)
1. Done

### Nested Lists

1. First list item
    - First nested list item
        - list item
        - list item
    - Second nested list item
        - list item
        - list item
1. Second list item
    - list item
    - list item
        - list item

______________________________________________________________________

### Task lists

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:
- [ ] (Optional) Open a followup issue

@github/support What do you think about these updates?

______________________________________________________________________

### emoji

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

______________________________________________________________________

### Hiding content with comments

<!-- This content will not appear in the rendered Markdown -->

______________________________________________________________________

### Ignoring Markdown formatting

Let's rename \*our-new-project\* to \*our-old-project\*.

______________________________________________________________________

### Table

| Left-aligned | Center-aligned | Right-aligned |
| :----------- | :------------: | ------------: |
| git status   |   git status   |    git status |
| git diff     |    git diff    |      git diff |

______________________________________________________________________

### Diagrams

Here is a simple flow chart:

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

[external link]: https://github.com/czuli/github-markdown-example/tree/7326f19c94be992319394e5bfeaa07b30f858e46