DEV Community

loading...

Adding pages to Jekyll site

ravgeetdhillon profile image Ravgeet Dhillon Originally published at ravgeet.dev on ・3 min read

This is tutorial can be used to add pages to any Jekyll site. I am assuming that you have setup your Ruby Development Environment. If not, then refer to this document here to get started easily.

Below are few easy steps that you can follow to add pages to your Jekyll site. I have also attached images to explain the process better.

Note: I have taken the example of GTK Website, I’m working on. You can find it’s Gitlab instance here.

Step 1.

In collections/_docs directory, create a new file with name: hello-world.md.

Creating a new Markdown file.

Step 2.

I want this page to be available at the following link: http://localhost:4000/docs/tutorials/hello-world/

Add the following front matter to the hello-world.md.

---
permalink: /docs/tutorials/:name/
---

Adding the front matter to the Markdown file.

Step 3.

Add your content in the Markdown format to the `hello-world.md.

`
This is the demo file to show the process of adding new pages to a Jekyll site.

`

Adding the new content to the Markdown file.

Step 4.

In _data directory, open the navigation.yml file and update the sidebar_links array by adding the following content:

`

  • title: Hello World name: hello-world section: Tutorials

`

here,

  • title is display text on sidebar on docs page
  • name is the name of the file which should be pointed to when the link is accessed
  • section is category this page should fall under

Updating YML file in the Jekyll Project.

Step 5.

In case the new file is the main section page, then update the sidebar_sections array by adding the following content:

`

  • title: Tutorials name: tutorials

`

here,

  • title is display text on sidebar on docs page
  • name is the name of the file which should be pointed to when the link is accessed

Updating YML file in the Jekyll Project.

Step 6.

Save all the files and serve the website on the local server by running the following command.

`
bundle exec jekyll serve

`

Compiling the Jekyll website.

Step 7.

Go to http://localhost:4000/docs/tutorials/hello-world/ and the page is up and running.

Fetching the Jekyll website on the localhost.

Fetching the Jekyll website on the localhost.

Lemme know if you have any doubt, appreciation or anything else that you would like to communicate to me. You can tweet me @ravgeetdhillon. I reply to all the questions as quickly as possible. πŸ˜„ And if you liked this post, please share it with your twitter community as well.

Discussion

pic
Editor guide