From 98522b03caca41fc66ee6cdddecdc7d0f1624232 Mon Sep 17 00:00:00 2001 From: Anindita Basu Date: Thu, 5 Dec 2019 15:09:29 +0530 Subject: [PATCH] Improve index page of Jekyll documentation (#7926) Merge pull request 7926 --- docs/_docs/index.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/_docs/index.md b/docs/_docs/index.md index b3a6c7fd..0266aac1 100644 --- a/docs/_docs/index.md +++ b/docs/_docs/index.md @@ -6,33 +6,37 @@ redirect_from: - /docs/quickstart/ - /docs/extras/ --- -Jekyll is a simple, extendable, static site generator. You give it text written -in your favorite markup language and it churns through layouts to create a -static website. Throughout that process you can tweak how you want the site URLs -to look, what data gets displayed in the layout, and more. +Jekyll is an extendable static site generator. You give it text written in your +favorite markup language and it uses layouts to create a static website. You can +tweak how you want the site URLs to look like, what data gets displayed on the +site, and more. + +## Prerequities + +See [requirements](/docs/installation/#requirements). ## Instructions -1. Install a full [Ruby development environment](/docs/installation/) -2. Install Jekyll and [bundler](/docs/ruby-101/#bundler) [gems](/docs/ruby-101/#gems) +1. Install a full [Ruby development environment](/docs/installation/). +2. Install Jekyll and [bundler](/docs/ruby-101/#bundler) [gems](/docs/ruby-101/#gems). ``` gem install jekyll bundler ``` -3. Create a new Jekyll site at `./myblog` +3. Create a new Jekyll site at `./myblog`. ``` jekyll new myblog ``` -4. Change into your new directory +4. Change into your new directory. ``` cd myblog ``` -5. Build the site and make it available on a local server +5. Build the site and make it available on a local server. ``` bundle exec jekyll serve ``` -6. Now browse to [http://localhost:4000](http://localhost:4000){:target="_blank"} +6. Browse to [http://localhost:4000](http://localhost:4000){:target="_blank"} -If you encounter any unexpected errors during the above, please refer to the -[troubleshooting](/docs/troubleshooting/#configuration-problems) page or the -already-mentioned [requirements](/docs/installation/#requirements) page, as -you might be missing development headers or other prerequisites. +If you encounter any errors during this process, see the +[troubleshooting](/docs/troubleshooting/#configuration-problems) page. Also, +make sure you've installed the development headers and other prerequisites as +mentioned on the [requirements](/docs/installation/#requirements) page.