This README document provides information on setting up and managing a personal Jekyll site hosted on GitHub Pages, initially developed with Docker. It includes instructions for installation, local development, deployment, and customization of your Jekyll site.
To get started with your personal Jekyll site, follow these steps:
-
Clone the repository to your local machine using the following command:
git clone <repository-url>
-
Install Docker on your machine. Refer to the Docker documentation for instructions specific to your operating system.
To develop your Jekyll site locally using Docker, follow these steps:
-
Change into the project directory:
cd <project-directory>
-
Build the Docker image:
docker build -t jekyll-site .
-
Run the Docker container:
docker run --rm -p 4000:4000 -v $(pwd):/srv/jekyll jekyll-site
-
Open your browser and visit
http://localhost:4000
to preview your site.
To deploy your Jekyll site to GitHub Pages, follow these steps:
-
Create a new repository on GitHub with the name
<your-username>.github.io
. -
Push your local repository to the remote repository:
git remote add origin <repository-url> git push -u origin master
-
Enable GitHub Pages for your repository:
- Go to the repository settings.
- Under the "GitHub Pages" section, choose the branch you want to use for deployment (usually
master
). - Save the settings.
-
Your Jekyll site will be published and accessible at
https://<your-username>.github.io
.
To customize your Jekyll site, consider the following options:
- Layouts: Modify or create new layouts in the
_layouts
directory. - Styles: Customize the appearance of your site by editing the CSS files located in the
assets/css
directory. - Content: Update the content in the
_posts
and_pages
directories. - Plugins: Install and configure plugins by adding them to the
Gemfile
and_config.yml
files.
Make sure to consult the Jekyll documentation for detailed information on customizing your site.
Here are some additional resources that can help you with your personal Jekyll site:
- Jekyll Documentation - Official documentation for Jekyll.
- GitHub Pages Documentation - Learn more about hosting your site on GitHub Pages.
- Docker Documentation - Official documentation for Docker.
Feel free to explore and experiment with different features and functionalities provided by Jekyll to create a unique and personalized website.
This project is licensed under the MIT License.