Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 89 lines (56 sloc) 3.949 kB
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
1 # We Are All Awesome
2
872965b @theophani update README
theophani authored
3 A site with the intention of motivating, encouraging, and helping people begin speaking at conferences.
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
4
872965b @theophani update README
theophani authored
5 The site contains: advice on writing proposals and slides, links to great talks, links to other resources, etc.
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
6
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
7 ## How Contribute
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
8
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
9 1. [Fork the repository](https://help.github.com/articles/fork-a-repo)
10 2. Make your changes
11 3. [Submit a pull request](https://help.github.com/articles/using-pull-requests)
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
12
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
13 ### Powered with Github Pages + Jekyll
14
872965b @theophani update README
theophani authored
15 This site is powered by [Github Pages](https://help.github.com/articles/using-jekyll-with-pages), which is powered with [Jekyll](https://github.com/mojombo/jekyll/blob/master/README.markdown).
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
16
872965b @theophani update README
theophani authored
17 The magic: If your repository has a branch named gh-pages, Github automatically creates Github Pages for the repo. If you want to have a static site, you can have *just* a branch called gh-pages. Ta da!
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
18
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
19 ### Text format
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
20
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
21 All the posts are written in markdown. If you're not familiar with markdown, check out [Daring Fireball's syntax guide](http://daringfireball.net/projects/markdown/syntax).
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
22
872965b @theophani update README
theophani authored
23 ### Adding a page or post
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
24
872965b @theophani update README
theophani authored
25 Blog posts (opinion, advice, timely news) goes in the `_posts` directory, and must be named `YYYY-MM-DD-the-title-of-the-post.md`.
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
26
0b1a7db @theophani it's called front matter, not head matter
theophani authored
27 Start your page/post off with the following Jekyll “front matter”:
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
28
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
29 ```
30 ---
31 layout: main
32 title: The Title of the Post
33 ---
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
34
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
35 # {{ page.title }}
36 ```
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
37
38 (where you'd swap out `The Title of the Post` with the actual title, obviously).
39
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
40 Then add whatever content you want below this header. Write your post in [markdown](http://daringfireball.net/projects/markdown/syntax).
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
41
0b1a7db @theophani it's called front matter, not head matter
theophani authored
42 Instructional/informational articles for speakers and curators go into the respective for_speakers and for_curators directories. The “front matter” for these pages is slightly different; take a look at the existing page to see what is required.
872965b @theophani update README
theophani authored
43
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
44 ### Eyeballing Your Changes
45
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
46 For small changes, you can safely make a pull request without previewing the changes.
47
48 To preview your changes to the site on your machine, you must use [Jekyll](https://github.com/mojombo/jekyll/blob/master/README.textile) to build the HTML version and serve the files.
49
50 First, be sure you have Jekyll installed:
51
52 gem install jekyll
53
872965b @theophani update README
theophani authored
54 Second, in the root of the project, run `jekyll serve` to generate the HTML files, and start the server:
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
55
872965b @theophani update README
theophani authored
56 jekyll serve -w
9c90d42 @chiuki Added --auto flag to jekyll command
chiuki authored
57
872965b @theophani update README
theophani authored
58 `-w` enables live reload so you don't need to restart the server to see your changes.
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
59
872965b @theophani update README
theophani authored
60 When you run `jekyll serve` you'll probably see webrick start up. Look for the port number:
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
61
62 [2012-06-23 14:02:42] INFO WEBrick::HTTPServer#start: pid=3642 port=4000
63
1378455 @theophani whoops -- backwards brackets
theophani authored
64 Here it started on port 4000, which is usual. That means that you can see your preview of the site at [localhost:4000](http://localhost:4000/)
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
65
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
66 ## If you have further questions, ask Uncle Google
ef21b3d @kytrinyx Add a getting started guide to the readme
kytrinyx authored
67
564173b @theophani fixed formatting and typos in README
theophani authored
68 Actual conversation (with typos corrected) from #stationx on freenode about how I need to write a README
39e7556 @theophani README
theophani authored
69
a69fbab @theophani clarifying the role of github pages and jekyll
theophani authored
70 theophani: so the key thing to google is "jekyll github pages"
71 theophani: I had never heard of it before either
72 theophani: and spent 2.5 hours being super frustrated that I could not figure out how
73 to edit the site after @janl set it up for me.
74 theophani: he would have helped, if I'd asked.
75 theophani: warning: the actual github pages help are not helpful.
76 fnords: i will use my google-fu to figure it out
77 theophani: intro: https://help.github.com/articles/using-jekyll-with-pages
78 theophani: actual help: https://github.com/mojombo/jekyll/blob/master/README.textile
79 theophani: premise: if you have a branch named gh-pages, you automatically create
80 github pages for the repo. if you want to have a blog, you can have JUST
81 a branch called gh-pages
82 fnords: aha!
83 ln2v: oh, so they don't actually go into master?
84 theophani: exactly
85 theophani: I should copy and paste this conversation as the readme :D
86 ln2v: feel free! ;)
39e7556 @theophani README
theophani authored
87
88 station x (cc)
Something went wrong with that request. Please try again.