Skip to content

[Feature Request]: Adding Jekyll Tutorial under docs. #3622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
4 tasks done
sjain1970 opened this issue Jul 20, 2024 · 3 comments · Fixed by #3706
Closed
4 tasks done

[Feature Request]: Adding Jekyll Tutorial under docs. #3622

sjain1970 opened this issue Jul 20, 2024 · 3 comments · Fixed by #3706
Assignees
Labels
CodeHarborHub - Thanks for creating an issue! documentation Improvements or additions to documentation gssoc GirlScript Summer of Code | Contributor GSSOC'24 GirlScript Summer of Code | Contributor level2 GirlScript Summer of Code | Contributor's Levels tutorial Label for tutorials and educational content.

Comments

@sjain1970
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Feature Description

Jekyll is a static site generator written in Ruby. It allows you to transform your plain text into static websites and blogs, making it particularly popular for building personal blogs, project documentation, and company sites.
I propose adding a comprehensive Jekyll tutorial under the Docs section. This tutorial will cover the following topics to help users get started and effectively use Jekyll for static site generation:

-Introduction to Jekyll
-Installing Jekyll
-Setting up a new Jekyll site
-Jekyll configuration
-Creating pages and posts
-Using themes
-Working with layouts and includes
-Jekyll plugins
-Deployment
-Best practices and troubleshooting

Use Case

This feature would enhance my use of the project by providing a structured and detailed guide for using Jekyll. For example, new users unfamiliar with Jekyll can quickly get up to speed and create their static websites efficiently.

Benefits

A specific scenario where this feature would be beneficial is for developers looking to create personal blogs or project documentation sites using Jekyll. The tutorial will provide step-by-step instructions, making it easier for users to understand and implement Jekyll, resulting in a smooth setup and deployment process.

Add ScreenShots

No response

Priority

High

Record

  • I have read the Contributing Guidelines
  • I'm a GSSOC'24 contributor
  • I have starred the repository
@sjain1970 sjain1970 added the enhancement New feature or request label Jul 20, 2024
Copy link

Hi @sjain1909! Thanks for opening this issue. We appreciate your contribution to this open-source project. Your input is valuable and we aim to respond or assign your issue as soon as possible. Thanks again!

@sjain1970
Copy link
Contributor Author

@ajay-dhangar sir, kindly assign me this issue under GSSOC'24.

@ajay-dhangar ajay-dhangar added documentation Improvements or additions to documentation GSSOC'24 GirlScript Summer of Code | Contributor level2 GirlScript Summer of Code | Contributor's Levels gssoc GirlScript Summer of Code | Contributor tutorial Label for tutorials and educational content. labels Jul 20, 2024
@ajay-dhangar ajay-dhangar moved this to In Progress in @CodeHarborHub's Docs Jul 20, 2024
sjain1970 added a commit to sjain1970/gssocproject1 that referenced this issue Jul 21, 2024
## Fixing Issue codeharborhub#3622

## Description

This pull request adds a comprehensive Jekyll tutorial to the documentation. The tutorial covers the basics of setting up a Jekyll site, creating posts and pages, using templates and layouts, and customizing the site with themes and plugins. It also includes examples and step-by-step instructions to help beginners understand and build their own Jekyll sites.

## Type of PR

- [ ] Bug fix
- [x] Feature enhancement
- [ ] Documentation update
- [ ] Security enhancement
- [ ] Other (specify): _______________

## Checklist
- [x] I have performed a self-review of my code.
- [x] I have read and followed the Contribution Guidelines.
- [x] I have tested the changes thoroughly before submitting this pull request.
- [x] I have provided relevant issue numbers, screenshots, and videos after making the changes.
- [x] I have commented my code, particularly in hard-to-understand areas.
- [x] I have followed the code style guidelines of this project.
- [x] I have checked for any existing open issues that my pull request may address.
- [x] I have ensured that my changes do not break any existing functionality.
- [x] Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently.
- [x] I have read the resources for guidance listed below.
- [x] I have followed security best practices in my code changes.

## Additional Context

This Jekyll tutorial includes:
- Setting up a Jekyll development environment.
- Creating and managing posts and pages.
- Using and customizing templates and layouts.
- Applying themes and integrating plugins for added functionality.
- Step-by-step instructions and examples for beginners to get started with Jekyll.

## Resources for Guidance

Please read the following resources before submitting your contribution:

- [x] [Code Harbor Hub Community Features](https://www.codeharborhub.live/community/features)
- [x] [Markdown Guide](https://www.markdownguide.org/)
@sjain1970 sjain1970 mentioned this issue Jul 21, 2024
18 tasks
@github-project-automation github-project-automation bot moved this from In Progress to Done in @CodeHarborHub's Docs Jul 21, 2024
Copy link

Hello @sjain1909! Your issue #3622 has been closed. Thank you for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CodeHarborHub - Thanks for creating an issue! documentation Improvements or additions to documentation gssoc GirlScript Summer of Code | Contributor GSSOC'24 GirlScript Summer of Code | Contributor level2 GirlScript Summer of Code | Contributor's Levels tutorial Label for tutorials and educational content.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants