Skip to content

Instantly share code, notes, and snippets.

@duggi
Created April 22, 2011 05:12
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save duggi/936070 to your computer and use it in GitHub Desktop.
Save duggi/936070 to your computer and use it in GitHub Desktop.
api doc test

lets go ahead and use markdown in github wiki pages for now

the only elements we should need are:

  • h1, h2, h3
  • blockquote
  • p
  • pre
  • code
  • ul/ol
  • horizontal rule

github flavored markdown also accepts the code blocks, eg ```javascript your code here ```

lets see how it looks in lighthouse:


this is an h1

important text usually underneath h* in a blockquote

this should be a p

this should be another p

this is an h2

when documenting inline code blocks like how to use ENV_VARS use the code element

longer blocks use the triple-backtick: (same as using pre html tag, but with syntax highlighting)

var foo = bar;
function foo() {
  alert('foo');
}

if using pre, be sure to line break at col 80! otherwise it will put up the scroll bars.

to test this out in github, click Edit on this comment and copy paste the text in the textarea to a github gist

lets go ahead and use markdown in github wiki pages for now
the only elements we should need are:
* h1, h2, h3
* blockquote
* p
* pre
* code
* ul/ol
* horizontal rule
github flavored markdown also accepts the code blocks, eg \`\`\`js your code here \`\`\`
lets see how it looks in lighthouse:
----
# this is an h1
important text usually underneath h* in a blockquote
this should be a p
this should be another p
## this is an h2
when documenting inline `code` blocks like how to use `ENV_VARS` use the code element
longer blocks use the triple-backtick: (same as using `pre` html tag, but with syntac highlighting)
``` javascript
var foo = bar;
function foo() {
alert('foo');
}
```
if using pre, be sure to line break at col 80! otherwise it will put up the scroll bars.
to test this out in github, click `Edit` on this comment and copy paste the text in the textarea to a github gist
lets go ahead and use markdown in github wiki pages for now
the only elements we should need are:
* h1, h2, h3
* blockquote
* p
* pre
* code
* ul/ol
* horizontal rule
github flavored markdown also accepts the code blocks, eg \`\`\`js your code here \`\`\`
lets see how it looks in lighthouse:
----
# this is an h1
important text usually underneath h* in a blockquote
this should be a p
this should be another p
## this is an h2
when documenting inline `code` blocks like how to use `ENV_VARS` use the code element
longer blocks use the triple-backtick: (same as using `pre` html tag, but with syntac highlighting)
``` javascript
var foo = bar;
function foo() {
alert('foo');
}
```
if using pre, be sure to line break at col 80! otherwise it will put up the scroll bars.
to test this out in github, click `Edit` on this comment and copy paste the text in the textarea to a github gist
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment