From 7a1254563ae71dd15ff554a1576b4d46084ee5d1 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Thu, 18 Oct 2018 14:04:09 +0200 Subject: [PATCH] Docs: reorganize README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Put things in order: getting started, diving in, then asking for help 😄 --- README.markdown | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.markdown b/README.markdown index a6a670b8..15ed9ec5 100644 --- a/README.markdown +++ b/README.markdown @@ -24,10 +24,6 @@ Jekyll does what you tell it to do — no more, no less. It doesn't try to outs See: https://jekyllrb.com/philosophy -## Having trouble? - -See: https://jekyllrb.com/docs/troubleshooting/ - ## Getting Started * [Install](https://jekyllrb.com/docs/installation/) the gem @@ -36,6 +32,20 @@ See: https://jekyllrb.com/docs/troubleshooting/ * [Fork](https://github.com/jekyll/jekyll/fork) and [Contribute](https://jekyllrb.com/docs/contributing/) your own modifications * Have questions? Check out our official forum community [Jekyll Talk](https://talk.jekyllrb.com/) or [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/) +## Diving In + +* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system +* Learn how [Front Matter](https://jekyllrb.com/docs/front-matter/) works +* Put information on your site with [Variables](https://jekyllrb.com/docs/variables/) +* Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with +* Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier +* Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site +* Watch [video tutorials from Giraffe Academy](https://jekyllrb.com/tutorials/video-walkthroughs/) + +## Need help? + +If you don't find the answer to your problem in our [docs](https://jekyllrb.com/docs/), or in the [troubleshooting section](https://jekyllrb.com/docs/troubleshooting/), ask the [community](https://jekyllrb.com/docs/community/) for help. + ## Code of Conduct In order to have a more open and welcoming community, Jekyll adheres to a @@ -47,16 +57,6 @@ Jekyll community. It is strictly enforced on all official Jekyll repositories, websites, and resources. If you encounter someone violating these terms, please let one of our [core team members](https://jekyllrb.com/team/#core-team) know and we will address it as soon as possible. -## Diving In - -* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system -* Learn how [Front Matter](https://jekyllrb.com/docs/front-matter/) works -* Put information on your site with [Variables](https://jekyllrb.com/docs/variables/) -* Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with -* Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier -* Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site -* Watch [video tutorials from Giraffe Academy](https://jekyllrb.com/tutorials/video-walkthroughs/) - ## Credits ### Contributors @@ -78,7 +78,6 @@ Support this project by becoming a sponsor. Your logo will show up here with a l - ## License See the [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE) file.