Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added some content #6

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions _layouts/base.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This had a valid html5 doctype. Why should we change this? I see no reason. Both html and xhtml are valid under html5.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for sticking with <!DOCTYPE html>.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok my bad.

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
<head profile="http://www.w3.org/2005/10/profile">
<link rel="icon" type="image/png" href="/images/favicon.png" />
<meta charset='utf-8' />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
<meta name="description" content="Markdown Community Page : By and for the markdown community." />
Expand Down
6 changes: 6 additions & 0 deletions _layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
<h1 id="project_title">Markdown Community Page</h1>
<h2 id="project_tagline">By and for the markdown community.</h2>
</header>
<div id="navbar">
<ul>
<li><a href="/">Home</a></li>
<li><a href="/about.html">About</a></li>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the static site generation tool we're using support URLs without extensions? The usual hack is to have foo.md produce foo/index.html, giving a path of /foo/ rather than /foo.html. This is preferable.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No it doesn't I tried to do it without the .html but it wouldn't pick it up.

</ul>
</div>
</div>
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
Expand Down
27 changes: 27 additions & 0 deletions about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: index
---

## About
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need an about page? This is short. Why can't this content exist on the front page? While I'm not opposed to an about page, I ask mainly because all other parts of this merge request seem to be misguided. Maybe this is actually a good idea? I don't know.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well it was suggested in issue #2 and I thought it was a good idea. It looks good too.


Markdown is formatting syntax that is lightweight, easy to write and easy to read. It's main goal is to be as readable as possible as plain text:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/It's/Its/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as readable as possible as plain text

This wording is a little off.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed.


> "The overriding design goal for Markdown’s formatting syntax is to make
it as readable as possible. The idea is that a Markdown-formatted
document should be publishable as-is, as plain text, without looking
like it’s been marked up with tags or formatting instructions. While
Markdown’s syntax has been influenced by several existing text-to-HTML
filters, the single biggest source of inspiration for Markdown’s syntax
is the format of plain text email." - [John Gruber](http://daringfireball.net/projects/markdown/)

Various libraries are available to convert markdown into structurally valid XHTML. This makes it possible to produce rich text documents in a syntax that's nearly as powerful as HTML, but much easier to use.

### History

Markdown was originally authored by John Gruber and Alex Swartz and is officially hosted at John Grubers [site](http://daringfireball.net/projects/markdown/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Grubers/Gruber's/

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure? John Gruber is site?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the possessive. The dog's bowl means the bowl belonging to the dog. Apostrophes are confusing because they're also used in contractions.


Markdown rose in popularity after [Github](https://github.com) implemented it and since then many other sites have followed.

### The future

The markdown community hopes to use this site and its [associated Github account](https://github.com/markdown) to [be a better parent](http://www.codinghorror.com/blog/2009/12/responsible-open-source-code-parenting.html) to Markdown. It will be a central location for information on markdown and will help move markdown forwards and into maturity.
Binary file added images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 33 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: index
---
### Welcome to the Markdown Community Page
[Markdown][1] is a
[Markdown][1] is:

> a text-to-HTML conversion tool for web writers. Markdown allows you to
> write using an easy-to-read, easy-to-write plain text format, then
Expand All @@ -12,14 +12,44 @@ This page is maintained by and for the markdown community to document various
tools and resources available to document authors and developers, as well as
implementors of the various markdown implementations.

### Want to help?

Got an idea for this site? You help by [joining the discussion](https://github.com/markdown/markdown.github.com/issues) on github and sharing your ideas. If you've read the discussions and think there's something you can do you can dive right in and fork [this sites Github repository](https://github.com/markdown/markdown.github.com), [make your changes](https://github.com/markdown/markdown.github.com/wiki/How-to-edit-the-site) and [do a pull request](https://help.github.com/articles/using-pull-requests).

### Authors
Coming soon...

### Developers
Coming soon...

These are some developers who have written Markdown parsers:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was intended to be a list of resources for developers, not a list of developers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, when we say "developers" we mean developers of other produces which use markdown libraries. Not developers of markdown libraries.


* [John Gruber](http://daringfireball.net/)
* [evilstreak](https://github.com/evilstreak)
* [michelf](https://github.com/michelf)
* [waylan](https://github.com/waylan)
* [vmg](https://github.com/vmg)


### Libraries

These are some libraries that will parse markdown:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A much more complete list already exists in the wiki here: https://github.com/markdown/markdown.github.com/wiki/Implementations We should simply link to that page rather than reproduce an incomplete list here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reckon it would be a good idea to just put that huge list you made into a dedicated page on the website (ala issue #1), but keep it on the wiki as well. The wiki page will be like bleeding edge content that is copied to the site when it is updated.


* [Markdown](http://daringfireball.net/projects/markdown/) - John Grubers perl script
* [markdown-js](https://github.com/evilstreak/markdown-js) - a Markdown parser for javascript
* [php-markdown](https://github.com/michelf/php-markdown) - a port to PHP of John Grubers Markdown perl script (plus more)
* [Python-Markdown](https://github.com/waylan/Python-Markdown) - a Python implementation of John Grubers Markdown
* [github-flavored-markdown](https://github.com/github/github-flavored-markdown) - Githubs version of markdown
* [sundown](https://github.com/vmg/sundown) - a markdown parser in C
* [redcarpet](https://github.com/vmg/redcarpet) - a markdown parser in ruby (available as a gem)


### Implementors
Coming soon...

These are some implementations of markdown:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is intended to be a list of resources for implementors of markdown libraries, not a list of implementations.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. I think we need to make the language clearer then. Maybe more conversational... like... "Implementing markdown in your project? Check this out" or something.


* [Github](https://github.com) - Use a modified markdown for issues, comments and wiki pages
* [Bitbucket](https://bitbucket.org) - uses markdown for issues
* [StackOverflow and others](https://stackexchange.com/) - the entire StackExchange network uses markdown
* [markdown-here](https://github.com/adam-p/markdown-here) - a browser extension to render markdown in emails

[1]: http://daringfireball.net/projects/markdown/
24 changes: 24 additions & 0 deletions stylesheets/stylesheet.css
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,30 @@ Full-Width Styles
text-shadow: #111 0px 0px 10px;
}

#navbar {
text-align: right;
margin: 0 auto;
position: relative;
max-width: 640px;
}

#navbar ul li {
list-style-type: none;
display: inline;
}

#navbar ul li a {
font-size: 20px;
color: #0090ff;
padding: 10px;
}

#navbar ul li a:hover {
background-color: #0090ff;
color: white;
border-radius: 10px;
}

#downloads {
position: absolute;
width: 210px;
Expand Down