diff --git a/Rakefile b/Rakefile index 4e9a1057..58aecfaf 100644 --- a/Rakefile +++ b/Rakefile @@ -27,6 +27,10 @@ def docs_name "#{name}-docs" end +def docs_folder + "docs" +end + def gemspec_file "#{name}.gemspec" end @@ -102,7 +106,7 @@ def siteify_file(file, overrides_front_matter = {}) "note" => "This file is autogenerated. Edit /#{file} instead." }.merge(overrides_front_matter) contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}" - File.write("site/_docs/#{slug}.md", contents) + File.write("#{docs_folder}/_docs/#{slug}.md", contents) end def content_for(file) diff --git a/site/.gitignore b/docs/.gitignore similarity index 100% rename from site/.gitignore rename to docs/.gitignore diff --git a/site/404.html b/docs/404.html similarity index 100% rename from site/404.html rename to docs/404.html diff --git a/site/CNAME b/docs/CNAME similarity index 100% rename from site/CNAME rename to docs/CNAME diff --git a/site/_config.yml b/docs/_config.yml similarity index 90% rename from site/_config.yml rename to docs/_config.yml index 5333c52e..6f57710a 100644 --- a/site/_config.yml +++ b/docs/_config.yml @@ -1,6 +1,5 @@ markdown: kramdown highlighter: rouge -permalink: /news/:year/:month/:day/:title/ gauges_id: 503c5af6613f5d0f19000027 google_analytics_id: UA-50755011-1 @@ -14,6 +13,9 @@ timezone: America/Los_Angeles collections: docs: output: true + posts: + permalink: /news/:year/:month/:day/:title/ + output: true name: Jekyll • Simple, blog-aware, static sites description: Transform your plain text into static websites and blogs diff --git a/site/_data/docs.yml b/docs/_data/docs.yml similarity index 97% rename from site/_data/docs.yml rename to docs/_data/docs.yml index 071b5a14..4ff28ba2 100644 --- a/site/_data/docs.yml +++ b/docs/_data/docs.yml @@ -46,5 +46,6 @@ - title: Meta docs: - contributing + - maintaining - conduct - history diff --git a/site/_data/jekyllconf-talks.yml b/docs/_data/jekyllconf-talks.yml similarity index 100% rename from site/_data/jekyllconf-talks.yml rename to docs/_data/jekyllconf-talks.yml diff --git a/site/_docs/assets.md b/docs/_docs/assets.md similarity index 100% rename from site/_docs/assets.md rename to docs/_docs/assets.md diff --git a/site/_docs/collections.md b/docs/_docs/collections.md similarity index 100% rename from site/_docs/collections.md rename to docs/_docs/collections.md diff --git a/site/_docs/conduct.md b/docs/_docs/conduct.md similarity index 100% rename from site/_docs/conduct.md rename to docs/_docs/conduct.md diff --git a/site/_docs/configuration.md b/docs/_docs/configuration.md similarity index 100% rename from site/_docs/configuration.md rename to docs/_docs/configuration.md diff --git a/site/_docs/continuous-integration.md b/docs/_docs/continuous-integration.md similarity index 100% rename from site/_docs/continuous-integration.md rename to docs/_docs/continuous-integration.md diff --git a/site/_docs/contributing.md b/docs/_docs/contributing.md similarity index 100% rename from site/_docs/contributing.md rename to docs/_docs/contributing.md diff --git a/site/_docs/datafiles.md b/docs/_docs/datafiles.md similarity index 100% rename from site/_docs/datafiles.md rename to docs/_docs/datafiles.md diff --git a/site/_docs/deployment-methods.md b/docs/_docs/deployment-methods.md similarity index 100% rename from site/_docs/deployment-methods.md rename to docs/_docs/deployment-methods.md diff --git a/site/_docs/drafts.md b/docs/_docs/drafts.md similarity index 100% rename from site/_docs/drafts.md rename to docs/_docs/drafts.md diff --git a/site/_docs/extras.md b/docs/_docs/extras.md similarity index 100% rename from site/_docs/extras.md rename to docs/_docs/extras.md diff --git a/site/_docs/frontmatter.md b/docs/_docs/frontmatter.md similarity index 100% rename from site/_docs/frontmatter.md rename to docs/_docs/frontmatter.md diff --git a/site/_docs/github-pages.md b/docs/_docs/github-pages.md similarity index 100% rename from site/_docs/github-pages.md rename to docs/_docs/github-pages.md diff --git a/site/_docs/history.md b/docs/_docs/history.md similarity index 100% rename from site/_docs/history.md rename to docs/_docs/history.md diff --git a/site/_docs/index.md b/docs/_docs/index.md similarity index 100% rename from site/_docs/index.md rename to docs/_docs/index.md diff --git a/site/_docs/installation.md b/docs/_docs/installation.md similarity index 100% rename from site/_docs/installation.md rename to docs/_docs/installation.md diff --git a/docs/affinity-team-captain.md b/docs/_docs/maintaining/affinity-team-captain.md similarity index 96% rename from docs/affinity-team-captain.md rename to docs/_docs/maintaining/affinity-team-captain.md index ccdcec7a..02247d2d 100644 --- a/docs/affinity-team-captain.md +++ b/docs/_docs/maintaining/affinity-team-captain.md @@ -1,6 +1,10 @@ -# Affinity Team Captains +--- +title: Affinity Team Captains +layout: docs +--- **This guide is for affinity team captains.** These special people are **team maintainers** of one of our [affinity teams][] and help triage and evaluate the issues and contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } ## Affinity teams & their captains diff --git a/docs/avoiding-burnout.md b/docs/_docs/maintaining/avoiding-burnout.md similarity index 97% rename from docs/avoiding-burnout.md rename to docs/_docs/maintaining/avoiding-burnout.md index f5625e68..a418cefd 100644 --- a/docs/avoiding-burnout.md +++ b/docs/_docs/maintaining/avoiding-burnout.md @@ -1,6 +1,10 @@ -# Maintainers: Avoiding Burnout +--- +title: "Avoiding Burnout" +layout: docs +--- **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } # 1. Use Jekyll diff --git a/docs/becoming-a-maintainer.md b/docs/_docs/maintaining/becoming-a-maintainer.md similarity index 97% rename from docs/becoming-a-maintainer.md rename to docs/_docs/maintaining/becoming-a-maintainer.md index f6473787..c4a262b9 100644 --- a/docs/becoming-a-maintainer.md +++ b/docs/_docs/maintaining/becoming-a-maintainer.md @@ -1,6 +1,10 @@ -# Contributors: Becoming a Maintainer +--- +title: "Becoming a Maintainer" +layout: docs +--- **This guide is for contributors.** These special people have contributed to one or more of Jekyll's repositories, but do not yet have write access to any. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } So you want to become a maintainer of a Jekyll project? We'd love to have you! Here are some things we like to see from community members before we promote them to maintainers. diff --git a/docs/_docs/maintaining/index.md b/docs/_docs/maintaining/index.md new file mode 100644 index 00000000..5c4da4db --- /dev/null +++ b/docs/_docs/maintaining/index.md @@ -0,0 +1,21 @@ +--- +layout: docs +title: Maintaining Jekyll +permalink: /docs/maintaining/ +--- + +**This guide is for Jekyll contributors and maintainers.** These special people contribute to one or more of Jekyll's repositories or help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } + +Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer. + +1. [Affinity teams & their captains](affinity-team-captain/) +2. [Triaging and issue](triaging-an-issue/) +3. [Reviewing a pull request](reviewing-a-pull-request/) +4. [Merging a pull request](merging-a-pull-request/) +5. [Avoiding burnout](avoiding-burnout/) +6. [Special Labels](special-labels/) + +Interested in becoming a maintainer? Here is some documentation for **contributors**: + +1. [Becoming a maintainer](becoming-a-maintainer/) diff --git a/docs/merging-a-pull-request.md b/docs/_docs/maintaining/merging-a-pull-request.md similarity index 97% rename from docs/merging-a-pull-request.md rename to docs/_docs/maintaining/merging-a-pull-request.md index 3d56b096..7265c6f8 100644 --- a/docs/merging-a-pull-request.md +++ b/docs/_docs/maintaining/merging-a-pull-request.md @@ -1,6 +1,10 @@ -# Maintainers: Merging a Pull Request +--- +title: "Merging a Pull Request" +layout: docs +--- **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } ## Code Review diff --git a/docs/reviewing-a-pull-request.md b/docs/_docs/maintaining/reviewing-a-pull-request.md similarity index 98% rename from docs/reviewing-a-pull-request.md rename to docs/_docs/maintaining/reviewing-a-pull-request.md index b2c3e0de..1ecaeea9 100644 --- a/docs/reviewing-a-pull-request.md +++ b/docs/_docs/maintaining/reviewing-a-pull-request.md @@ -1,6 +1,10 @@ -# Maintainers: Reviewing a Pull Request +--- +title: "Reviewing a Pull Request" +layout: docs +--- **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } ## Respond Kindly @@ -41,4 +45,3 @@ A pull request may be merged once two maintainers have reviewed the pull request ## Think Security We owe it to our users to ensure that using a theme from the community or building someone else's site doesn't come with built-in security vulnerabilities. Things like where files may be read from and written to are important to keep secure. Jekyll is also the basis for hosted services such as [GitHub Pages](https://pages.github.com), which cannot upgrade when security issues are introduced. - diff --git a/docs/special-labels.md b/docs/_docs/maintaining/special-labels.md similarity index 96% rename from docs/special-labels.md rename to docs/_docs/maintaining/special-labels.md index 8ce52597..ff8a623f 100644 --- a/docs/special-labels.md +++ b/docs/_docs/maintaining/special-labels.md @@ -1,6 +1,10 @@ -# Maintainers: Special Labels +--- +title: "Special Labels" +layout: docs +--- **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } We use a series of "special labels" on GitHub.com to automate handling of some parts of the pull request and issue process. @jekyllbot may automatically apply or remove certain labels based on actions taken by users or maintainers. Below are the labels and how they work: diff --git a/docs/triaging-an-issue.md b/docs/_docs/maintaining/triaging-an-issue.md similarity index 98% rename from docs/triaging-an-issue.md rename to docs/_docs/maintaining/triaging-an-issue.md index 405dffaf..4802b61b 100644 --- a/docs/triaging-an-issue.md +++ b/docs/_docs/maintaining/triaging-an-issue.md @@ -1,6 +1,10 @@ -# Maintainers: Triaging an Issue +--- +title: "Triaging an Issue" +layout: docs +--- **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. +{: .note .info } Before evaluating an issue, it is important to identify if it is a feature request or a bug. For the Jekyll project the following definitions are used diff --git a/site/_docs/migrations.md b/docs/_docs/migrations.md similarity index 100% rename from site/_docs/migrations.md rename to docs/_docs/migrations.md diff --git a/site/_docs/pages.md b/docs/_docs/pages.md similarity index 100% rename from site/_docs/pages.md rename to docs/_docs/pages.md diff --git a/site/_docs/pagination.md b/docs/_docs/pagination.md similarity index 100% rename from site/_docs/pagination.md rename to docs/_docs/pagination.md diff --git a/site/_docs/permalinks.md b/docs/_docs/permalinks.md similarity index 100% rename from site/_docs/permalinks.md rename to docs/_docs/permalinks.md diff --git a/site/_docs/plugins.md b/docs/_docs/plugins.md similarity index 100% rename from site/_docs/plugins.md rename to docs/_docs/plugins.md diff --git a/site/_docs/posts.md b/docs/_docs/posts.md similarity index 100% rename from site/_docs/posts.md rename to docs/_docs/posts.md diff --git a/site/_docs/quickstart.md b/docs/_docs/quickstart.md similarity index 100% rename from site/_docs/quickstart.md rename to docs/_docs/quickstart.md diff --git a/site/_docs/resources.md b/docs/_docs/resources.md similarity index 100% rename from site/_docs/resources.md rename to docs/_docs/resources.md diff --git a/site/_docs/sites.md b/docs/_docs/sites.md similarity index 100% rename from site/_docs/sites.md rename to docs/_docs/sites.md diff --git a/site/_docs/static_files.md b/docs/_docs/static_files.md similarity index 100% rename from site/_docs/static_files.md rename to docs/_docs/static_files.md diff --git a/site/_docs/structure.md b/docs/_docs/structure.md similarity index 100% rename from site/_docs/structure.md rename to docs/_docs/structure.md diff --git a/site/_docs/templates.md b/docs/_docs/templates.md similarity index 100% rename from site/_docs/templates.md rename to docs/_docs/templates.md diff --git a/site/_docs/themes.md b/docs/_docs/themes.md similarity index 100% rename from site/_docs/themes.md rename to docs/_docs/themes.md diff --git a/site/_docs/troubleshooting.md b/docs/_docs/troubleshooting.md similarity index 100% rename from site/_docs/troubleshooting.md rename to docs/_docs/troubleshooting.md diff --git a/site/_docs/upgrading.md b/docs/_docs/upgrading.md similarity index 100% rename from site/_docs/upgrading.md rename to docs/_docs/upgrading.md diff --git a/site/_docs/upgrading/0-to-2.md b/docs/_docs/upgrading/0-to-2.md similarity index 100% rename from site/_docs/upgrading/0-to-2.md rename to docs/_docs/upgrading/0-to-2.md diff --git a/site/_docs/upgrading/2-to-3.md b/docs/_docs/upgrading/2-to-3.md similarity index 100% rename from site/_docs/upgrading/2-to-3.md rename to docs/_docs/upgrading/2-to-3.md diff --git a/site/_docs/usage.md b/docs/_docs/usage.md similarity index 100% rename from site/_docs/usage.md rename to docs/_docs/usage.md diff --git a/site/_docs/variables.md b/docs/_docs/variables.md similarity index 100% rename from site/_docs/variables.md rename to docs/_docs/variables.md diff --git a/site/_docs/windows.md b/docs/_docs/windows.md similarity index 93% rename from site/_docs/windows.md rename to docs/_docs/windows.md index f64ac6d4..68edd8ef 100644 --- a/site/_docs/windows.md +++ b/docs/_docs/windows.md @@ -16,8 +16,10 @@ A quick way to install Jekyll is to follow the [installation instructions by Dav 2. Install Ruby via Chocolatey: `choco install ruby -y` 3. Reopen a command prompt and install Jekyll: `gem install jekyll` -For a more conventional way of installing Jekyll you can follow the [installation instruction by Julian Thilo][windows-installation]. The instructions were written for Ruby 2.0.0, but should work for later -versions [prior to 2.2][hitimes-issue]. +For a more conventional way of installing Jekyll you can follow the [installation instructions by Sverrir Sigmundarson][windows-installjekyll3]. These instructions are for newer versions of Ruby 2.2.5 and Jekyll 3. + +For instructions for older versions of Ruby 2.0.0 ([prior to 2.2][hitimes-issue]) and Jekyll 2 and older you should follow the [installation instruction by Julian Thilo][windows-installation]. + ## Encoding @@ -34,6 +36,7 @@ $ chcp 65001 ``` [windows-installation]: http://jekyll-windows.juthilo.com/ +[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/ [hitimes-issue]: https://github.com/copiousfreetime/hitimes/issues/40 ## Auto-regeneration diff --git a/site/_includes/analytics.html b/docs/_includes/analytics.html similarity index 100% rename from site/_includes/analytics.html rename to docs/_includes/analytics.html diff --git a/site/_includes/anchor_links.html b/docs/_includes/anchor_links.html similarity index 100% rename from site/_includes/anchor_links.html rename to docs/_includes/anchor_links.html diff --git a/site/_includes/docs_contents.html b/docs/_includes/docs_contents.html similarity index 100% rename from site/_includes/docs_contents.html rename to docs/_includes/docs_contents.html diff --git a/site/_includes/docs_contents_mobile.html b/docs/_includes/docs_contents_mobile.html similarity index 100% rename from site/_includes/docs_contents_mobile.html rename to docs/_includes/docs_contents_mobile.html diff --git a/site/_includes/docs_option.html b/docs/_includes/docs_option.html similarity index 100% rename from site/_includes/docs_option.html rename to docs/_includes/docs_option.html diff --git a/site/_includes/docs_ul.html b/docs/_includes/docs_ul.html similarity index 100% rename from site/_includes/docs_ul.html rename to docs/_includes/docs_ul.html diff --git a/site/_includes/footer.html b/docs/_includes/footer.html similarity index 100% rename from site/_includes/footer.html rename to docs/_includes/footer.html diff --git a/site/_includes/header.html b/docs/_includes/header.html similarity index 100% rename from site/_includes/header.html rename to docs/_includes/header.html diff --git a/site/_includes/news_contents.html b/docs/_includes/news_contents.html similarity index 100% rename from site/_includes/news_contents.html rename to docs/_includes/news_contents.html diff --git a/site/_includes/news_contents_mobile.html b/docs/_includes/news_contents_mobile.html similarity index 100% rename from site/_includes/news_contents_mobile.html rename to docs/_includes/news_contents_mobile.html diff --git a/site/_includes/news_item.html b/docs/_includes/news_item.html similarity index 100% rename from site/_includes/news_item.html rename to docs/_includes/news_item.html diff --git a/site/_includes/primary-nav-items.html b/docs/_includes/primary-nav-items.html similarity index 100% rename from site/_includes/primary-nav-items.html rename to docs/_includes/primary-nav-items.html diff --git a/site/_includes/section_nav.html b/docs/_includes/section_nav.html similarity index 100% rename from site/_includes/section_nav.html rename to docs/_includes/section_nav.html diff --git a/site/_includes/top.html b/docs/_includes/top.html similarity index 100% rename from site/_includes/top.html rename to docs/_includes/top.html diff --git a/site/_layouts/default.html b/docs/_layouts/default.html similarity index 100% rename from site/_layouts/default.html rename to docs/_layouts/default.html diff --git a/site/_layouts/docs.html b/docs/_layouts/docs.html similarity index 100% rename from site/_layouts/docs.html rename to docs/_layouts/docs.html diff --git a/site/_layouts/error.html b/docs/_layouts/error.html similarity index 100% rename from site/_layouts/error.html rename to docs/_layouts/error.html diff --git a/site/_layouts/news.html b/docs/_layouts/news.html similarity index 100% rename from site/_layouts/news.html rename to docs/_layouts/news.html diff --git a/site/_layouts/news_item.html b/docs/_layouts/news_item.html similarity index 100% rename from site/_layouts/news_item.html rename to docs/_layouts/news_item.html diff --git a/site/_layouts/page.html b/docs/_layouts/page.html similarity index 100% rename from site/_layouts/page.html rename to docs/_layouts/page.html diff --git a/site/_posts/2013-05-06-jekyll-1-0-0-released.markdown b/docs/_posts/2013-05-06-jekyll-1-0-0-released.markdown similarity index 100% rename from site/_posts/2013-05-06-jekyll-1-0-0-released.markdown rename to docs/_posts/2013-05-06-jekyll-1-0-0-released.markdown diff --git a/site/_posts/2013-05-08-jekyll-1-0-1-released.markdown b/docs/_posts/2013-05-08-jekyll-1-0-1-released.markdown similarity index 100% rename from site/_posts/2013-05-08-jekyll-1-0-1-released.markdown rename to docs/_posts/2013-05-08-jekyll-1-0-1-released.markdown diff --git a/site/_posts/2013-05-12-jekyll-1-0-2-released.markdown b/docs/_posts/2013-05-12-jekyll-1-0-2-released.markdown similarity index 100% rename from site/_posts/2013-05-12-jekyll-1-0-2-released.markdown rename to docs/_posts/2013-05-12-jekyll-1-0-2-released.markdown diff --git a/site/_posts/2013-06-07-jekyll-1-0-3-released.markdown b/docs/_posts/2013-06-07-jekyll-1-0-3-released.markdown similarity index 100% rename from site/_posts/2013-06-07-jekyll-1-0-3-released.markdown rename to docs/_posts/2013-06-07-jekyll-1-0-3-released.markdown diff --git a/site/_posts/2013-07-14-jekyll-1-1-0-released.markdown b/docs/_posts/2013-07-14-jekyll-1-1-0-released.markdown similarity index 100% rename from site/_posts/2013-07-14-jekyll-1-1-0-released.markdown rename to docs/_posts/2013-07-14-jekyll-1-1-0-released.markdown diff --git a/site/_posts/2013-07-24-jekyll-1-1-1-released.markdown b/docs/_posts/2013-07-24-jekyll-1-1-1-released.markdown similarity index 100% rename from site/_posts/2013-07-24-jekyll-1-1-1-released.markdown rename to docs/_posts/2013-07-24-jekyll-1-1-1-released.markdown diff --git a/site/_posts/2013-07-25-jekyll-1-0-4-released.markdown b/docs/_posts/2013-07-25-jekyll-1-0-4-released.markdown similarity index 100% rename from site/_posts/2013-07-25-jekyll-1-0-4-released.markdown rename to docs/_posts/2013-07-25-jekyll-1-0-4-released.markdown diff --git a/site/_posts/2013-07-25-jekyll-1-1-2-released.markdown b/docs/_posts/2013-07-25-jekyll-1-1-2-released.markdown similarity index 100% rename from site/_posts/2013-07-25-jekyll-1-1-2-released.markdown rename to docs/_posts/2013-07-25-jekyll-1-1-2-released.markdown diff --git a/site/_posts/2013-09-06-jekyll-1-2-0-released.markdown b/docs/_posts/2013-09-06-jekyll-1-2-0-released.markdown similarity index 100% rename from site/_posts/2013-09-06-jekyll-1-2-0-released.markdown rename to docs/_posts/2013-09-06-jekyll-1-2-0-released.markdown diff --git a/site/_posts/2013-09-14-jekyll-1-2-1-released.markdown b/docs/_posts/2013-09-14-jekyll-1-2-1-released.markdown similarity index 100% rename from site/_posts/2013-09-14-jekyll-1-2-1-released.markdown rename to docs/_posts/2013-09-14-jekyll-1-2-1-released.markdown diff --git a/site/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown b/docs/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown similarity index 100% rename from site/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown rename to docs/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown diff --git a/site/_posts/2013-11-04-jekyll-1-3-0-released.markdown b/docs/_posts/2013-11-04-jekyll-1-3-0-released.markdown similarity index 100% rename from site/_posts/2013-11-04-jekyll-1-3-0-released.markdown rename to docs/_posts/2013-11-04-jekyll-1-3-0-released.markdown diff --git a/site/_posts/2013-11-26-jekyll-1-3-1-released.markdown b/docs/_posts/2013-11-26-jekyll-1-3-1-released.markdown similarity index 100% rename from site/_posts/2013-11-26-jekyll-1-3-1-released.markdown rename to docs/_posts/2013-11-26-jekyll-1-3-1-released.markdown diff --git a/site/_posts/2013-12-07-jekyll-1-4-0-released.markdown b/docs/_posts/2013-12-07-jekyll-1-4-0-released.markdown similarity index 100% rename from site/_posts/2013-12-07-jekyll-1-4-0-released.markdown rename to docs/_posts/2013-12-07-jekyll-1-4-0-released.markdown diff --git a/site/_posts/2013-12-09-jekyll-1-4-1-released.markdown b/docs/_posts/2013-12-09-jekyll-1-4-1-released.markdown similarity index 100% rename from site/_posts/2013-12-09-jekyll-1-4-1-released.markdown rename to docs/_posts/2013-12-09-jekyll-1-4-1-released.markdown diff --git a/site/_posts/2013-12-16-jekyll-1-4-2-released.markdown b/docs/_posts/2013-12-16-jekyll-1-4-2-released.markdown similarity index 100% rename from site/_posts/2013-12-16-jekyll-1-4-2-released.markdown rename to docs/_posts/2013-12-16-jekyll-1-4-2-released.markdown diff --git a/site/_posts/2014-01-13-jekyll-1-4-3-released.markdown b/docs/_posts/2014-01-13-jekyll-1-4-3-released.markdown similarity index 100% rename from site/_posts/2014-01-13-jekyll-1-4-3-released.markdown rename to docs/_posts/2014-01-13-jekyll-1-4-3-released.markdown diff --git a/site/_posts/2014-03-24-jekyll-1-5-0-released.markdown b/docs/_posts/2014-03-24-jekyll-1-5-0-released.markdown similarity index 100% rename from site/_posts/2014-03-24-jekyll-1-5-0-released.markdown rename to docs/_posts/2014-03-24-jekyll-1-5-0-released.markdown diff --git a/site/_posts/2014-03-27-jekyll-1-5-1-released.markdown b/docs/_posts/2014-03-27-jekyll-1-5-1-released.markdown similarity index 100% rename from site/_posts/2014-03-27-jekyll-1-5-1-released.markdown rename to docs/_posts/2014-03-27-jekyll-1-5-1-released.markdown diff --git a/site/_posts/2014-05-06-jekyll-turns-2-0-0.markdown b/docs/_posts/2014-05-06-jekyll-turns-2-0-0.markdown similarity index 100% rename from site/_posts/2014-05-06-jekyll-turns-2-0-0.markdown rename to docs/_posts/2014-05-06-jekyll-turns-2-0-0.markdown diff --git a/site/_posts/2014-05-08-jekyll-2-0-3-released.markdown b/docs/_posts/2014-05-08-jekyll-2-0-3-released.markdown similarity index 100% rename from site/_posts/2014-05-08-jekyll-2-0-3-released.markdown rename to docs/_posts/2014-05-08-jekyll-2-0-3-released.markdown diff --git a/site/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown b/docs/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown similarity index 100% rename from site/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown rename to docs/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown diff --git a/site/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown b/docs/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown similarity index 100% rename from site/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown rename to docs/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown diff --git a/site/_posts/2014-07-01-jekyll-2-1-1-released.markdown b/docs/_posts/2014-07-01-jekyll-2-1-1-released.markdown similarity index 100% rename from site/_posts/2014-07-01-jekyll-2-1-1-released.markdown rename to docs/_posts/2014-07-01-jekyll-2-1-1-released.markdown diff --git a/site/_posts/2014-07-29-jekyll-2-2-0-released.markdown b/docs/_posts/2014-07-29-jekyll-2-2-0-released.markdown similarity index 100% rename from site/_posts/2014-07-29-jekyll-2-2-0-released.markdown rename to docs/_posts/2014-07-29-jekyll-2-2-0-released.markdown diff --git a/site/_posts/2014-08-10-jekyll-2-3-0-released.markdown b/docs/_posts/2014-08-10-jekyll-2-3-0-released.markdown similarity index 100% rename from site/_posts/2014-08-10-jekyll-2-3-0-released.markdown rename to docs/_posts/2014-08-10-jekyll-2-3-0-released.markdown diff --git a/site/_posts/2014-09-09-jekyll-2-4-0-released.markdown b/docs/_posts/2014-09-09-jekyll-2-4-0-released.markdown similarity index 100% rename from site/_posts/2014-09-09-jekyll-2-4-0-released.markdown rename to docs/_posts/2014-09-09-jekyll-2-4-0-released.markdown diff --git a/site/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown b/docs/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown similarity index 100% rename from site/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown rename to docs/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown diff --git a/site/_posts/2014-11-08-jekyll-2-5-1-released.markdown b/docs/_posts/2014-11-08-jekyll-2-5-1-released.markdown similarity index 100% rename from site/_posts/2014-11-08-jekyll-2-5-1-released.markdown rename to docs/_posts/2014-11-08-jekyll-2-5-1-released.markdown diff --git a/site/_posts/2014-11-12-jekyll-2-5-2-released.markdown b/docs/_posts/2014-11-12-jekyll-2-5-2-released.markdown similarity index 100% rename from site/_posts/2014-11-12-jekyll-2-5-2-released.markdown rename to docs/_posts/2014-11-12-jekyll-2-5-2-released.markdown diff --git a/site/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md b/docs/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md similarity index 100% rename from site/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md rename to docs/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md diff --git a/site/_posts/2014-12-22-jekyll-2-5-3-released.markdown b/docs/_posts/2014-12-22-jekyll-2-5-3-released.markdown similarity index 100% rename from site/_posts/2014-12-22-jekyll-2-5-3-released.markdown rename to docs/_posts/2014-12-22-jekyll-2-5-3-released.markdown diff --git a/site/_posts/2015-01-20-jekyll-meet-and-greet.markdown b/docs/_posts/2015-01-20-jekyll-meet-and-greet.markdown similarity index 100% rename from site/_posts/2015-01-20-jekyll-meet-and-greet.markdown rename to docs/_posts/2015-01-20-jekyll-meet-and-greet.markdown diff --git a/site/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown b/docs/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown similarity index 100% rename from site/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown rename to docs/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown diff --git a/site/_posts/2015-02-26-introducing-jekyll-talk.markdown b/docs/_posts/2015-02-26-introducing-jekyll-talk.markdown similarity index 100% rename from site/_posts/2015-02-26-introducing-jekyll-talk.markdown rename to docs/_posts/2015-02-26-introducing-jekyll-talk.markdown diff --git a/site/_posts/2015-10-26-jekyll-3-0-released.markdown b/docs/_posts/2015-10-26-jekyll-3-0-released.markdown similarity index 100% rename from site/_posts/2015-10-26-jekyll-3-0-released.markdown rename to docs/_posts/2015-10-26-jekyll-3-0-released.markdown diff --git a/site/_posts/2015-11-17-jekyll-3-0-1-released.markdown b/docs/_posts/2015-11-17-jekyll-3-0-1-released.markdown similarity index 100% rename from site/_posts/2015-11-17-jekyll-3-0-1-released.markdown rename to docs/_posts/2015-11-17-jekyll-3-0-1-released.markdown diff --git a/site/_posts/2016-01-20-jekyll-3-0-2-released.markdown b/docs/_posts/2016-01-20-jekyll-3-0-2-released.markdown similarity index 100% rename from site/_posts/2016-01-20-jekyll-3-0-2-released.markdown rename to docs/_posts/2016-01-20-jekyll-3-0-2-released.markdown diff --git a/site/_posts/2016-01-24-jekyll-3-1-0-released.markdown b/docs/_posts/2016-01-24-jekyll-3-1-0-released.markdown similarity index 100% rename from site/_posts/2016-01-24-jekyll-3-1-0-released.markdown rename to docs/_posts/2016-01-24-jekyll-3-1-0-released.markdown diff --git a/site/_posts/2016-01-28-jekyll-3-1-1-released.markdown b/docs/_posts/2016-01-28-jekyll-3-1-1-released.markdown similarity index 100% rename from site/_posts/2016-01-28-jekyll-3-1-1-released.markdown rename to docs/_posts/2016-01-28-jekyll-3-1-1-released.markdown diff --git a/site/_posts/2016-02-08-jekyll-3-0-3-released.markdown b/docs/_posts/2016-02-08-jekyll-3-0-3-released.markdown similarity index 100% rename from site/_posts/2016-02-08-jekyll-3-0-3-released.markdown rename to docs/_posts/2016-02-08-jekyll-3-0-3-released.markdown diff --git a/site/_posts/2016-02-19-jekyll-3-1-2-released.markdown b/docs/_posts/2016-02-19-jekyll-3-1-2-released.markdown similarity index 100% rename from site/_posts/2016-02-19-jekyll-3-1-2-released.markdown rename to docs/_posts/2016-02-19-jekyll-3-1-2-released.markdown diff --git a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md b/docs/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md similarity index 100% rename from site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md rename to docs/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md diff --git a/site/_posts/2016-04-19-jekyll-3-0-4-released.markdown b/docs/_posts/2016-04-19-jekyll-3-0-4-released.markdown similarity index 100% rename from site/_posts/2016-04-19-jekyll-3-0-4-released.markdown rename to docs/_posts/2016-04-19-jekyll-3-0-4-released.markdown diff --git a/site/_posts/2016-04-19-jekyll-3-1-3-released.markdown b/docs/_posts/2016-04-19-jekyll-3-1-3-released.markdown similarity index 100% rename from site/_posts/2016-04-19-jekyll-3-1-3-released.markdown rename to docs/_posts/2016-04-19-jekyll-3-1-3-released.markdown diff --git a/site/_posts/2016-04-26-jekyll-3-0-5-released.markdown b/docs/_posts/2016-04-26-jekyll-3-0-5-released.markdown similarity index 100% rename from site/_posts/2016-04-26-jekyll-3-0-5-released.markdown rename to docs/_posts/2016-04-26-jekyll-3-0-5-released.markdown diff --git a/site/_posts/2016-05-18-jekyll-3-1-4-released.markdown b/docs/_posts/2016-05-18-jekyll-3-1-4-released.markdown similarity index 100% rename from site/_posts/2016-05-18-jekyll-3-1-4-released.markdown rename to docs/_posts/2016-05-18-jekyll-3-1-4-released.markdown diff --git a/site/_posts/2016-05-18-jekyll-3-1-5-released.markdown b/docs/_posts/2016-05-18-jekyll-3-1-5-released.markdown similarity index 100% rename from site/_posts/2016-05-18-jekyll-3-1-5-released.markdown rename to docs/_posts/2016-05-18-jekyll-3-1-5-released.markdown diff --git a/site/_posts/2016-05-19-jekyll-3-1-6-released.markdown b/docs/_posts/2016-05-19-jekyll-3-1-6-released.markdown similarity index 100% rename from site/_posts/2016-05-19-jekyll-3-1-6-released.markdown rename to docs/_posts/2016-05-19-jekyll-3-1-6-released.markdown diff --git a/site/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown b/docs/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown similarity index 100% rename from site/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown rename to docs/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown diff --git a/site/_posts/2016-07-26-jekyll-3-2-0-released.markdown b/docs/_posts/2016-07-26-jekyll-3-2-0-released.markdown similarity index 100% rename from site/_posts/2016-07-26-jekyll-3-2-0-released.markdown rename to docs/_posts/2016-07-26-jekyll-3-2-0-released.markdown diff --git a/site/_posts/2016-08-02-jekyll-3-2-1-released.markdown b/docs/_posts/2016-08-02-jekyll-3-2-1-released.markdown similarity index 100% rename from site/_posts/2016-08-02-jekyll-3-2-1-released.markdown rename to docs/_posts/2016-08-02-jekyll-3-2-1-released.markdown diff --git a/site/_posts/2016-08-24-jekyll-admin-initial-release.markdown b/docs/_posts/2016-08-24-jekyll-admin-initial-release.markdown similarity index 100% rename from site/_posts/2016-08-24-jekyll-admin-initial-release.markdown rename to docs/_posts/2016-08-24-jekyll-admin-initial-release.markdown diff --git a/site/_posts/2016-10-06-jekyll-3-3-is-here.md b/docs/_posts/2016-10-06-jekyll-3-3-is-here.md similarity index 100% rename from site/_posts/2016-10-06-jekyll-3-3-is-here.md rename to docs/_posts/2016-10-06-jekyll-3-3-is-here.md diff --git a/site/_sass/_font-awesome.scss b/docs/_sass/_font-awesome.scss similarity index 100% rename from site/_sass/_font-awesome.scss rename to docs/_sass/_font-awesome.scss diff --git a/site/_sass/_gridism.scss b/docs/_sass/_gridism.scss similarity index 100% rename from site/_sass/_gridism.scss rename to docs/_sass/_gridism.scss diff --git a/site/_sass/_mixins.scss b/docs/_sass/_mixins.scss similarity index 100% rename from site/_sass/_mixins.scss rename to docs/_sass/_mixins.scss diff --git a/site/_sass/_normalize.scss b/docs/_sass/_normalize.scss similarity index 100% rename from site/_sass/_normalize.scss rename to docs/_sass/_normalize.scss diff --git a/site/_sass/_pygments.scss b/docs/_sass/_pygments.scss similarity index 100% rename from site/_sass/_pygments.scss rename to docs/_sass/_pygments.scss diff --git a/site/_sass/_style.scss b/docs/_sass/_style.scss similarity index 100% rename from site/_sass/_style.scss rename to docs/_sass/_style.scss diff --git a/site/community/index.md b/docs/community/index.md similarity index 100% rename from site/community/index.md rename to docs/community/index.md diff --git a/site/css/screen.scss b/docs/css/screen.scss similarity index 100% rename from site/css/screen.scss rename to docs/css/screen.scss diff --git a/site/favicon.ico b/docs/favicon.ico similarity index 100% rename from site/favicon.ico rename to docs/favicon.ico diff --git a/site/fonts/fontawesome-webfont.eot b/docs/fonts/fontawesome-webfont.eot similarity index 100% rename from site/fonts/fontawesome-webfont.eot rename to docs/fonts/fontawesome-webfont.eot diff --git a/site/fonts/fontawesome-webfont.svg b/docs/fonts/fontawesome-webfont.svg similarity index 100% rename from site/fonts/fontawesome-webfont.svg rename to docs/fonts/fontawesome-webfont.svg diff --git a/site/fonts/fontawesome-webfont.ttf b/docs/fonts/fontawesome-webfont.ttf similarity index 100% rename from site/fonts/fontawesome-webfont.ttf rename to docs/fonts/fontawesome-webfont.ttf diff --git a/site/fonts/fontawesome-webfont.woff b/docs/fonts/fontawesome-webfont.woff similarity index 100% rename from site/fonts/fontawesome-webfont.woff rename to docs/fonts/fontawesome-webfont.woff diff --git a/site/fonts/fontawesome-webfont.woff2 b/docs/fonts/fontawesome-webfont.woff2 similarity index 100% rename from site/fonts/fontawesome-webfont.woff2 rename to docs/fonts/fontawesome-webfont.woff2 diff --git a/site/freenode.txt b/docs/freenode.txt similarity index 100% rename from site/freenode.txt rename to docs/freenode.txt diff --git a/site/help/index.md b/docs/help/index.md similarity index 100% rename from site/help/index.md rename to docs/help/index.md diff --git a/site/img/article-footer.png b/docs/img/article-footer.png similarity index 100% rename from site/img/article-footer.png rename to docs/img/article-footer.png diff --git a/site/img/footer-arrow.png b/docs/img/footer-arrow.png similarity index 100% rename from site/img/footer-arrow.png rename to docs/img/footer-arrow.png diff --git a/site/img/footer-logo.png b/docs/img/footer-logo.png similarity index 100% rename from site/img/footer-logo.png rename to docs/img/footer-logo.png diff --git a/site/img/jekyll-sticker.jpg b/docs/img/jekyll-sticker.jpg similarity index 100% rename from site/img/jekyll-sticker.jpg rename to docs/img/jekyll-sticker.jpg diff --git a/site/img/logo-2x.png b/docs/img/logo-2x.png similarity index 100% rename from site/img/logo-2x.png rename to docs/img/logo-2x.png diff --git a/site/img/logo-rss.png b/docs/img/logo-rss.png similarity index 100% rename from site/img/logo-rss.png rename to docs/img/logo-rss.png diff --git a/site/img/octojekyll.png b/docs/img/octojekyll.png similarity index 100% rename from site/img/octojekyll.png rename to docs/img/octojekyll.png diff --git a/site/index.html b/docs/index.html similarity index 100% rename from site/index.html rename to docs/index.html diff --git a/site/js/html5shiv.min.js b/docs/js/html5shiv.min.js similarity index 100% rename from site/js/html5shiv.min.js rename to docs/js/html5shiv.min.js diff --git a/site/js/respond.min.js b/docs/js/respond.min.js similarity index 100% rename from site/js/respond.min.js rename to docs/js/respond.min.js diff --git a/site/latest_version.txt b/docs/latest_version.txt similarity index 100% rename from site/latest_version.txt rename to docs/latest_version.txt diff --git a/site/news/index.html b/docs/news/index.html similarity index 100% rename from site/news/index.html rename to docs/news/index.html diff --git a/site/news/releases/index.html b/docs/news/releases/index.html similarity index 100% rename from site/news/releases/index.html rename to docs/news/releases/index.html diff --git a/docs/readme.md b/docs/readme.md index f2cb1fed..674d8b36 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,13 +1,16 @@ -# Maintaining Jekyll +# Jekyll docs site -Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer. +This directory contains the code for the Jekyll docs site, [jekyllrb.com](http://jekyllrb.com/). -1. [Triaging and issue](triaging-an-issue.md) -2. [Reviewing a pull request](reviewing-a-pull-request.md) -3. [Merging a pull request](merging-a-pull-request.md) -4. [Avoiding burnout](avoiding-burnout.md) -5. [Special Labels](special-labels.md) +## Contributing -Interested in becoming a maintainer? Here is some documentation for **contributors**: +For information about contributing, see the [Contributing page](http://jekyllrb.com/docs/contributing/). -1. [Becoming a maintainer](becoming-a-maintainer.md) +## Running locally + +You can preview your contributions before opening a pull request by running from within the directory: + +1. `bundle install --without test test_legacy benchmark` +2. `bundle exec rake site:preview` + +It's just a jekyll site, afterall! :wink: diff --git a/site/redirects/github.html b/docs/redirects/github.html similarity index 100% rename from site/redirects/github.html rename to docs/redirects/github.html diff --git a/site/redirects/issues.html b/docs/redirects/issues.html similarity index 100% rename from site/redirects/issues.html rename to docs/redirects/issues.html diff --git a/rake/site.rake b/rake/site.rake index 8dd283fb..45b0cac2 100644 --- a/rake/site.rake +++ b/rake/site.rake @@ -12,19 +12,19 @@ namespace :site do require "launchy" require "jekyll" - # Yep, it's a hack! Wait a few seconds for the Jekyll site to generate and - # then open it in a browser. Someday we can do better than this, I hope. - Thread.new do - sleep 4 - puts "Opening in browser..." + browser_launched = false + Jekyll::Hooks.register :site, :post_write do |site| + next if browser_launched + browser_launched = true + Jekyll.logger.info "Opening in browser..." Launchy.open("http://localhost:4000") end # Generate the site in server mode. puts "Running Jekyll..." options = { - "source" => File.expand_path("site"), - "destination" => File.expand_path("site/_site"), + "source" => File.expand_path(docs_folder), + "destination" => File.expand_path("#{docs_folder}/_site"), "watch" => true, "serving" => true } @@ -36,70 +36,26 @@ namespace :site do task :generate => :generated_pages do require "jekyll" Jekyll::Commands::Build.process({ - "profile" => true, - "source" => File.expand_path("site"), - "destination" => File.expand_path("site/_site") + "profile" => true, + "source" => File.expand_path(docs_folder), + "destination" => File.expand_path("#{docs_folder}/_site") }) end task :build => :generate desc "Update normalize.css library to the latest version and minify" task :update_normalize_css do - Dir.chdir("site/_sass") do + Dir.chdir("#{docs_folder}/_sass") do sh 'curl "http://necolas.github.io/normalize.css/latest/normalize.css" -o "normalize.scss"' sh 'sass "normalize.scss":"_normalize.scss" --style compressed' rm ['normalize.scss', Dir.glob('*.map')].flatten end end - desc "Commit the local site to the gh-pages branch and publish to GitHub Pages" + desc "Generate generated pages and publish to GitHub Pages" task :publish => :generated_pages do - # Ensure the gh-pages dir exists so we can generate into it. - puts "Checking for gh-pages dir..." - unless File.exist?("./gh-pages") - puts "Creating gh-pages dir..." - sh "git clone git@github.com:jekyll/jekyll gh-pages" - end - - # Ensure latest gh-pages branch history. - Dir.chdir('gh-pages') do - sh "git checkout gh-pages" - sh "git pull origin gh-pages" - end - - # Proceed to purge all files in case we removed a file in this release. - puts "Cleaning gh-pages directory..." - purge_exclude = %w[ - gh-pages/. - gh-pages/.. - gh-pages/.git - gh-pages/.gitignore - ] - FileList["gh-pages/{*,.*}"].exclude(*purge_exclude).each do |path| - sh "rm -rf #{path}" - end - - # Copy site to gh-pages dir. - puts "Building site into gh-pages branch..." - ENV['JEKYLL_ENV'] = 'production' - require "jekyll" - Jekyll::Commands::Build.process({ - "source" => File.expand_path("site"), - "destination" => File.expand_path("gh-pages"), - "sass" => { "style" => "compressed" } - }) - - File.open('gh-pages/.nojekyll', 'wb') { |f| f.puts(":dog: food.") } - - # Commit and push. - puts "Committing and pushing to GitHub Pages..." - sha = `git rev-parse HEAD`.strip - Dir.chdir('gh-pages') do - sh "git add ." - sh "git commit --allow-empty -m 'Updating to #{sha}.'" - sh "git push origin gh-pages" - end - puts 'Done.' + puts "GitHub Pages now compiles our docs site on every push to the `master` branch. Cool, huh?" + exit 1 end desc "Create a nicely formatted history page for the jekyll site based on the repo history." @@ -123,7 +79,7 @@ namespace :site do desc "Write the site latest_version.txt file" task :version_file do - File.open('site/latest_version.txt', 'wb') { |f| f.puts(version) } unless version =~ /(beta|rc|alpha)/i + File.open("#{docs_folder}/latest_version.txt", 'wb') { |f| f.puts(version) } unless version =~ /(beta|rc|alpha)/i end namespace :releases do @@ -132,7 +88,7 @@ namespace :site do raise "Specify a version: rake site:releases:new['1.2.3']" unless args.version today = Time.new.strftime('%Y-%m-%d') release = args.version.to_s - filename = "site/_posts/#{today}-jekyll-#{release.split('.').join('-')}-released.markdown" + filename = "#{docs_folder}/_posts/#{today}-jekyll-#{release.split('.').join('-')}-released.markdown" File.open(filename, "wb") do |post| post.puts("---") diff --git a/site/README.md b/site/README.md deleted file mode 100644 index 674d8b36..00000000 --- a/site/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Jekyll docs site - -This directory contains the code for the Jekyll docs site, [jekyllrb.com](http://jekyllrb.com/). - -## Contributing - -For information about contributing, see the [Contributing page](http://jekyllrb.com/docs/contributing/). - -## Running locally - -You can preview your contributions before opening a pull request by running from within the directory: - -1. `bundle install --without test test_legacy benchmark` -2. `bundle exec rake site:preview` - -It's just a jekyll site, afterall! :wink: