Skip to content

musiccow/github-markdown-example

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 

Repository files navigation

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

This is a subscript text


Superscript

This is a superscript text


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:

git status
git add
git commit

Syntax highlighting

ruby code

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

bash code

# 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
  2. 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.


Section links

Contribution guidelines for this project


Image

image from internet

This is an image

image from repo with link


Specifying the theme an image is shown to

Shows an illustrated sun in light color mode and a moon with stars in dark color mode.

List

Normal list

  • George Washington
  • John Adams
  • Thomas Jefferson

Order list

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

Nested Lists

  1. First list item
    • First nested list item
      • list item
      • list item
    • Second nested list item
      • list item
      • list item
  2. Second list item
    • list item
    • list item
      • list item

Task lists

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


emoji

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


Footnotes

Here is a simple footnote1.

A footnote can also have multiple lines2.

You can also use words, to fit your writing style more closely3.


Hiding content with comments


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:

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
Loading

Footnotes

  1. My reference.

  2. Every new line should be prefixed with 2 spaces.
    This allows you to have a footnote with multiple lines.

  3. Named footnotes will still render with numbers instead of the text but allow easier identification and linking.
    This footnote also has been made with a different syntax using 4 spaces for new lines.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published