GitXplorerGitXplorer
e

writing-on-github

public
0 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
0ccb7db4caa2f60b32a6fa2db5f07e6db27d5d03

Update README.md

eeyecatchup committed 10 years ago
Unverified
0e7624d7a8c145bdbf5709af0940aebbcbfcdf53

Update README.md

eeyecatchup committed 10 years ago
Unverified
0d250c3097a3869bcc4fbc46762a13bcfee2836f

Update README.md

eeyecatchup committed 10 years ago
Unverified
8bad989972195e95be10352f1b83416591596afd

Update README.md

eeyecatchup committed 10 years ago
Unverified
0cc8add4d05ccfe0960b7f6293cf32a738ee1604

Update README.md

eeyecatchup committed 10 years ago
Unverified
008b4412225f21da02f29370e6c58f66b4bdce23

Update README.md

eeyecatchup committed 10 years ago

README

The README file for this repository.

WRITING ON GITHUB

===================

This is just a private backup of Github's post series "Writing on Github".
I'm gonna add some more, relevant information from other sources soon
and will leave this here as a private markdown reference.


Table of Contents

  1. WRITING ON GITHUB
    1. GitHub Flavored Markdown (GFM) 3. GFM vs. Standard Markdown (SM) 4. Multiple underscores in words 5. URL autolinking 6. Strikethrough 7. Fenced code blocks 8. Syntax highlighting 9. Tables 2. GFM Markup 2. Newlines 3. Task lists 4. References 5. GFM Features 6. Quick quoting 7. Name and Team @mentions autocomplete 8. Emoji autocomplete 9. Issue autocompletion 10. Zen Mode (fullscreen) writing 11. HTML
  2. (GF) MARKDOWN BASICS 2. Basic writing 3. Paragraphs 4. Headings 5. Blockquotes 6. Styling text 7. Lists 8. Unordered lists 9. Ordered lists 10. Nested lists 11. Code Formatting 12. Inline formats 13. Multiple lines 14. Links


Backup of https://help.github.com/articles/markdown-basics/, created 2014/11/18.

MARKDOWN BASICS

Markdown allows you to write using an easy-to-read, easy-to-write plain text format, which then converts to valid HTML for viewing on GitHub

--

Basic writing


Paragraphs

Paragraphs in Markdown are just one or more lines of consecutive text followed by one or more blank lines.

On July 2, an alien mothership entered Earth's orbit and deployed several dozen saucer-shaped "destroyer" spacecraft, each 15 miles (24 km) wide.
 
On July 3, the Black Knights, a squadron of Marine Corps F/A-18 Hornets, participated in an assault on a destroyer near the city of Los Angeles.

--

Headings

You can create a heading by adding one or more # symbols before your heading text. The number of # you use will determine the size of the heading.

# The largest heading (an <h1> tag)
## The second largest heading (an <h2> tag)
…
###### The 6th largest heading (an <h6> tag)

--

Blockquotes
You can indicate [blockquotes][bq] with a `>`.

In the words of Abraham Lincoln:

> Pardon my french

--

Styling text

You can make text bold or italic.

*This text will be italic*
**This text will be bold**

Both bold and italic can use either a * or an _ around the text for styling. This allows you to combine both bold and italic if needed.

**Everyone _must_ attend the meeting at 5 o'clock today.**

--

Lists


Unordered lists

You can make an unordered list by preceding list items with either a * or a -.

* Item
* Item
* Item

- Item
- Item
- Item

--

Ordered lists

You can make an ordered list by preceding list items with a number.

1. Item 1
2. Item 2
3. Item 3

--

Nested lists

You can create nested lists by indenting list items by two spaces.

1. Item 1
  1. A corollary to the above item.
  2. Yet another point to consider.
2. Item 2
  * A corollary that does not need to be ordered.
    * This is indented four spaces, because it's two spaces further than the item above.
    * You might want to consider making a new list.
3. Item 3

--

Code formatting


Inline formats

Use single backticks (`) to format text in a special monospace format. Everything within the backticks appear as-is, with no other special formatting.

Here's an idea: why don't we take `SuperiorProject` and turn it into `**Reasonable**Project`.

--

Multiple lines

You can use triple backticks (```) to format text as its own distinct block.

Check out this neat program I wrote:

```
x = 0  
x = 2 + 2
what is x
```

--

Links


You can create an inline link by wrapping link text in brackets ( [ ] ), and then wrapping the link in parenthesis ( ( ) ).

For example, to create a hyperlink to www.github.com, with a link text that says, Visit GitHub!, you'd write this in Markdown: [Visit GitHub!](www.github.com).

--

END of "Markdown basics".