Improve index page of Jekyll documentation (#7926)
Merge pull request 7926
This commit is contained in:
parent
9557e68551
commit
98522b03ca
|
@ -6,33 +6,37 @@ redirect_from:
|
||||||
- /docs/quickstart/
|
- /docs/quickstart/
|
||||||
- /docs/extras/
|
- /docs/extras/
|
||||||
---
|
---
|
||||||
Jekyll is a simple, extendable, static site generator. You give it text written
|
Jekyll is an extendable static site generator. You give it text written in your
|
||||||
in your favorite markup language and it churns through layouts to create a
|
favorite markup language and it uses layouts to create a static website. You can
|
||||||
static website. Throughout that process you can tweak how you want the site URLs
|
tweak how you want the site URLs to look like, what data gets displayed on the
|
||||||
to look, what data gets displayed in the layout, and more.
|
site, and more.
|
||||||
|
|
||||||
|
## Prerequities
|
||||||
|
|
||||||
|
See [requirements](/docs/installation/#requirements).
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
1. Install a full [Ruby development environment](/docs/installation/)
|
1. Install a full [Ruby development environment](/docs/installation/).
|
||||||
2. Install Jekyll and [bundler](/docs/ruby-101/#bundler) [gems](/docs/ruby-101/#gems)
|
2. Install Jekyll and [bundler](/docs/ruby-101/#bundler) [gems](/docs/ruby-101/#gems).
|
||||||
```
|
```
|
||||||
gem install jekyll bundler
|
gem install jekyll bundler
|
||||||
```
|
```
|
||||||
3. Create a new Jekyll site at `./myblog`
|
3. Create a new Jekyll site at `./myblog`.
|
||||||
```
|
```
|
||||||
jekyll new myblog
|
jekyll new myblog
|
||||||
```
|
```
|
||||||
4. Change into your new directory
|
4. Change into your new directory.
|
||||||
```
|
```
|
||||||
cd myblog
|
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
|
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
|
If you encounter any errors during this process, see the
|
||||||
[troubleshooting](/docs/troubleshooting/#configuration-problems) page or the
|
[troubleshooting](/docs/troubleshooting/#configuration-problems) page. Also,
|
||||||
already-mentioned [requirements](/docs/installation/#requirements) page, as
|
make sure you've installed the development headers and other prerequisites as
|
||||||
you might be missing development headers or other prerequisites.
|
mentioned on the [requirements](/docs/installation/#requirements) page.
|
||||||
|
|
Loading…
Reference in New Issue