linkanmajumder / github-pages-with-jekyll Goto Github PK

View Code? Open in Web Editor NEW

0.0 0.0 0.0 20 KB

My blog

Home Page: https://linkanmajumder.github.io/github-pages-with-jekyll/

License: MIT License

github-pages-with-jekyll's Introduction

Academic Pages

This website is under development... coming soon

Getting Started

Register a GitHub account if you don't have one and confirm your e-mail (required!)
Click the "Use this template" button in the top right.
On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL.
Set site-wide configuration and add your content.
Upload any files (like PDFs, .zip files, etc.) to the files/ directory. They will appear at https://[your GitHub username].github.io/files/example.pdf.
Check status by going to the repository settings, in the "GitHub pages" section
(Optional) Use the Jupyter notebooks or python scripts in the markdown_generator folder to generate markdown files for publications and talks from a TSV file.

See more info at https://academicpages.github.io/

Running Locally

When you are initially working your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to:

Clone the repository and made updates as detailed above.
Make sure you have ruby-dev, bundler, and nodejs installed: sudo apt install ruby-dev ruby-bundler nodejs
Run bundle install to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
Run jekyll serve -l -H localhost to generate the HTML and serve it from localhost:4000 the local server will automatically rebuild and refresh the pages on change.

If you are running on Linux it may be necessary to install some additional dependencies prior to being able to run locally: sudo apt install build-essentials gcc make

Maintenance

Bug reports and feature requests to the template should be submitted via GitHub. For questions concerning how to style the template, please feel free to start a new discussion on GitHub.

This repository was forked (then detached) by Stuart Geiger from the Minimal Mistakes Jekyll Theme, which is © 2016 Michael Rose and released under the MIT License (see LICENSE.md). It is currently being maintained by Robert Zupko and additional maintainers would be welcomed.

Bugfixes and enhancements

If you have bugfixes and enhancements that you would like to submit as a pull request, you will need to fork this repository as opposed to using it as a template. This will also allow you to synchronize your copy of template to your fork as well.

Unfortunately, one logistical issue with a template theme like Academic Pages that makes it a little tricky to get bug fixes and updates to the core theme. If you use this template and customize it, you will probably get merge conflicts if you attempt to synchronize. If you want to save your various .yml configuration files and markdown files, you can delete the repository and fork it again. Or you can manually patch.

github-pages-with-jekyll's People

Contributors

Watchers

github-pages-with-jekyll's Issues

Welcome

Step 1: Enable GitHub Pages

Welcome to GitHub Pages and Jekyll 🎉!

If you're new to GitHub Pages, or you want to learn how to build and host a GitHub Pages site, you're in the right place. With GitHub Pages, you can host content like documentation, resumes, or any other static content that you’d like.

In this course, you'll create a blog hosted on GitHub Pages and learn how to:

Enable GitHub Pages
Use Jekyll, a static site generator
Customize Jekyll sites with a theme and content

New to GitHub?

For this course, you'll need to know how to create a branch on GitHub, commit changes using Git, and open a pull request on GitHub. If you need a refresher on the GitHub flow, check out the Introduction to GitHub course.

⌨️ Activity: Generate a GitHub Pages site

The first step to publishing your blog to the web is to enable GitHub Pages on this repository ^📖. When you enable GitHub Pages on a repository, GitHub takes the content that's on the main branch and publishes a website based on its contents.

Under your repository name, click Settings.
In the "GitHub Pages" section, in the Source drop-down, select main branch.

After GitHub Pages is enabled and the site is started, we'll be ready to create some more content.

Turning on GitHub Pages creates a deployment of your repository. I may take up to a minute to respond as I await the deployment.

Return to this issue for my next comment.

Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response from me, wait a few seconds and refresh the page for your next steps.

Getting ready to blog

Step 4: Customize Site Details

Great work! You can see your published page here. If you don't see your changes right away, refresh the page.

Getting your page blog ready

Jekyll uses a file titled _config.yml to store settings for your site, your theme, and reusable content like your site title and GitHub handle.

You can check out the _config.yml file on the Code tab of your repository.

⌨️ Activity: Modify the config file

Let's change the _config.yml so it's a perfect fit for your new blog. First, we need to use a blog-ready theme. For this activity, we will use a theme named minima.

Navigate to the Code tab of this repository, and browse to the _config.yml file, or click this link here.
In the upper right corner, click ✏️ to open the file editor.
Add a theme: set to minima so it shows in the _config.yml file as below:
```
theme: minima
```
Modify the other configuration variables such as title:, author:, and description: to customize your site.
Click Create a new branch for this commit and start a pull request.
Open a pull request.