Git Product home page Git Product logo

readme-cheatsheet's Introduction

README-Cheatsheet

This is a cheatsheet to refer to when creating projects with brief writeup / setup guides.

Table of Content

Basic Stuff

This is a bold text. Alternatively, you can also bold text like this.

This is a italic text.

You can combine bold and italic text like this.

This is a strikethrough text.

Unordered list can use:

  • Asterisk Sign "*"
  • Minus Sign "-"
  • Plus Sign "+"

Create Blockquotes

You can create blockquotes (a line separator at the left hand side) using the ">" symbol. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam fermentum lorem quam, nec maximus magna sollicitudin ut. Vestibulum varius quam elit, ac tempus dui iaculis vel. Mauris et suscipit nibh.

Create Table

You can create table by using the "|" pipe symbol together with the header separator "----" or ":---:" (for center-aligning) .

The table row contents need not be aligned with spacing like the title. You can just compact it.

NAME: varchar USERNAME (p_key): varchar PASSWORD: varchar BALANCE: number
Nico Robin nico_robin password123 1000
Tony Chopper tony_chopper asdf123 2000
Sanji Vinsmoke sanji_vinsmoke dragon123 3000
Zoro Rorona zoro_rorona sword123 4000

Create Code

You can include line code like this pip install pandas in a paragraph using backticks.

Alternatively, you can write block codes in paragraphs using the triple backticks like this:

private String username;
private String password;

You can also include syntax highlighting for specific programming languages (need check which are supported) or other code related stuff (E.g. HTTP headers) as shown below:

var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s

HyperLinks

URLs and URLs in angle brackets will automatically get turned into links. http://www.google.com or http://www.google.com and sometimes google.com (but not on Github, for example).

Inline-style link

Inline-style link with title when hover

Reference-style link

Relative reference to a repository file

Number Reference-style link

Images

Using normal hyperlink with hover (hover to see the title text):

Inline-style: alt text

Using html tag:

readme-cheatsheet's People

Contributors

syux-ednc avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.