Overview:
The content discusses a simple guide on converting any Github repository with Markdown files into a basic website using Github Pages and Jekyll. It emphasizes the ease of the process by not needing the command line or Jekyll knowledge, ensuring compatibility with existing markdown files within the repository, and providing step-by-step instructions for activation.
Features:
- Simple Website Creation: Convert Github repositories with Markdown files into websites effortlessly.
- Browser-Based Solution: No command line usage required, the entire process can be done through the browser.
- Compatible with Existing Files: Works seamlessly with any existing markdown files in the repository without modifying them.
- Readability: Markdown files retain their readability and usability in both Github and the converted website.
- Custom Configuration: Easy tuning of Github Pages’ default configuration via the _config.yml file.
- Relative Path Linking: Ability to create links between Markdown files using relative paths for easy navigation.
- Free Website Hosting: Utilize Github Pages to host the converted website online for free.
Installation:
- Determine the repository where you want to activate Github Pages.
- Create a _config.yml file in the root of your repository with the provided content.
# Sample _config.yml content
markdown: kramdown
encoding: UTF-8
- Activate Github Pages in your repository configuration by navigating to Settings > Options > Github Pages, select master branch as the Source and Save.
- Choose a theme for your website.
- Access your website using the link provided by Github.
Summary:
The guide demonstrates a straightforward method to transform Github repositories filled with Markdown files into functional websites using Github Pages and Jekyll. By following the outlined steps, users can easily showcase their content online without the need for advanced technical knowledge or modifications to the existing files. Implementing a custom configuration via the _config.yml file allows for a tailored website experience while maintaining the readability and usability of the original Markdown files.
