From c97ceba55a7bd154342af8d3e9e30ebe5835ced6 Mon Sep 17 00:00:00 2001 From: Abhijit Kshirsagar Date: Sun, 2 Mar 2025 01:55:24 +0530 Subject: [PATCH] Update README --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c8f925e..580dbeb 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,28 @@ -## Local Deployment - ```bundle exec jekyll clean; bundle exec jekyll serve --livereload --watch``` +## About +This repository holds the source for my academic homepage, built with Jekyll, an open source static website generator. The theme / layout is adapted from [a template published by NCSU Libraries](https://github.com/NCSU-Libraries/jekyll-academic) which in turn is based on the [Minimal Mistakes theme by Michael Rose](https://github.com/mmistakes/minimal-mistakes). +## Major Changes +I have naturally changed the colors, fonts and other cosmetic components to my liking, but +the overall theme is largely unchanged. I have added two color definitions as well to reflect +the theme colors of my institute which I have named Jamun and Marigold. -## Introduction -This template utilizes Jekyll, an open source static website generator, as well as a theme based largely off of the Minimal Mistakes theme by Michael Rose. The purpose of this template is to provide you with a simple, well designed website that is optimized for hosting on Github pages. We aim to reduce the technological know-how and time that is usually required for maintaining a personal or professional website. +### Sites with non-root hosting -#### Why Should I Use This? -By using this template you will have a website that is well designed, easy to maintain, free to host and easy to update. While there are many options out there for personal and professional websites, most are dependant on the platform on which they were built, and cannot be easily migrated. This template, while built for Github Pages integration, provides flexibility should you choose to host it elsewhere. +When hosting in a service where the root directory for the site will be a subdirectory, e.g. in +my case the root directory for my page is (https://iitdh.ac.in/~kabhijit/), the paths of all stylesheets and other relative links need to point to ```/~kabhijit``` rather than the top-level root, i.e. ```/```. Normally, Jekyll themes use the variables ```baseurl``` or ```url``` to set these, but in this particular template the variable that needs to be used happens to be ```site.github.url```, presumably because this would be needed most commonly when deploying via github pages, to a URL like ```github.io/reponame/```. See the first few lines of the ```_config.yaml``` file for the syntax. If you are deploying to the root directory, this variable can be commented out. -## [Getting Started Guide](https://ncsu-libraries.github.io/jekyll-academic-docs/) -Complete documentation for getting started as well as advanced features of Jekyll Academic can be found at [https://ncsu-libraries.github.io/jekyll-academic-docs/](https://ncsu-libraries.github.io/jekyll-academic-docs/). +For **testing** this non-root situation locally, the best way is to serve the site locally with the path right away, and save future heartaches: +```bundle exec jekyll clean; bundle exec jekyll serve -b /path/to/dir --livereload --watch``` -## Migrating to a new default branch name -We've decided to change this project's default branch name to 'main'. If you've forked this repository prior to July 20th, 2021, then you should a message with update instructions when you go to your fork in github: +### Deploying -![fork renamed message](https://user-images.githubusercontent.com/3514165/126372022-ae4c07fa-dec7-427c-a4b5-cdd73aec75eb.png) - -In your fork on GitHub, go to the branches view, and click on the edit icon next to the 'master' branch. Change the branch name to main. Underneath the input box where you change the name you will be presented with the commands that you will need to run on your local copy of your fork. - -![local instructions for default branch name change ](https://user-images.githubusercontent.com/3514165/126372635-208fbc4b-698e-4938-bdae-5ff19eed2c96.png) +Remember to copy only the contents of the ```_site``` subdirectory over to the webserver. ## Upgrade Notes for June 2021 release + +__The following section is retained verbatim from the source repository and is needed only if you are using Reveal.js presentations__ + If you are running a fork of Jekyll Academic before June 2021, we made some breaking changes to upgrade the underlying Jekyll version and to address the constant github/dependabot security notices mentioned in issue #4. We have updated Jekyll to version 4 and removed reveal.js as an included library. We still want to support reveal.js presentations, so we have taken the suggestion from issue #4 and made the reveal.js directory a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). If you are running Jekyll Academic as a Github Page, this should hopefully be a minor change. @@ -32,7 +33,7 @@ If, however, you are running Jekyll Academic locally or on a custom server, afte If you have any reveal.js presentations posted, you may need to make some updates for them to display properly using reveal.js version 4. See [Jekyll's documentation](https://revealjs.com/upgrading/) for details. -## Keeping reveal.js up to date +### Keeping reveal.js up to date Moving forward, if you'd like to update reveal.js you will need to run the following commands: `$ git submodule update --remote`