Accessing the Documentation Locally

To view and edit the documentation locally on your computer, you will need to set up a local development environment using Jekyll, which is a popular static site generator. Follow the steps below to get started:

Prerequisites

What you need

  • Ruby
  • RubyGem
  • Bundler

1. Install Prerequisites

Read the official installation guide Jekyll official Installation Guide. It will guide your installation of Ruby and RubyGem step-by-step

  • If Bundler is not installed after finishing the above guide: Install Bundler by running gem install bundler in your terminal.

2. Fork to Your Own Repo

Click on this Link and find the fork button as shown in the image below

  • forking

3. Setting Up the Local Environment

  1. Clone your own repository to your local machine using the following command:

remember to replace YOUR_GITHUB_USERNAME with your actual GitHub username

1

   git clone https://github.com/YOUR_GITHUB_USERNAME/chrastillab.github.io

  1. Navigate to the repository’s root directory:

    1

    cd chrastillab.github.io

  2. Install the required dependencies using Bundler:

    1

    bundle install

4. Viewing the Documentation

  1. Once the dependencies are installed, you can start a local development server by running the following command:

    1

    bundle exec jekyll serve

  2. Open your web browser and visit the following URL:

    http://127.0.0.1:4000

    You should see the documentation website running locally.

Now go to next section to see how to editing and uploading the page