This PR changes README.md to encourage people to use `Use this template`
rather than `fork`.
### Differences between `Use this template` and fork
> - A new fork includes the entire commit history of the parent
repository, while a repository created from a template starts with a
single commit.
> - Commits to a fork don't appear in your contributions graph, while
commits to a repository created from a template do appear in your
contribution graph.
> - A fork can be a temporary way to contribute code to an existing
project, while creating a repository from a template starts a new
project quickly.
[Ref](https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
### Cons
Possible con would be that it is harder to pull the new changes from
this repo to the users' repos. It does not seem like impossible to do so
but it will require additonal actions on the users end.
- https://github.com/orgs/community/discussions/23528
-
https://stackoverflow.com/questions/56577184/github-pull-changes-from-a-template-repository
---------
Co-authored-by: Maruan <alshedivat@users.noreply.github.com>
This file makes it easier for windows users to use docker. (Closes#829)
Previous to this commit, those who used Windows had to install Ubuntu
inside windows (via WSL) and run our commands. Now they can run it by
just typing `docker-compose up`.
> The main problem was that `./bin/dockerhub_run.sh` command was written
with `Bash` in mind and you had to change it a little bit to make it
compatible with windows `Powershell`. We shouldn't have two scripts.
This is why adding a `docker-compose.yml` file is necessary.
[Altmetric](https://www.altmetric.com/) tracks social media and citation
activity for a paper. I added an option to add the altmeric id to a
paper's bib entry, which results in the altmeric badge for the paper
being displayed next to the other buttons. As an example, I added the
altmetric id for the Einstein, Podolsky & Rosen paper.
* Add support for github repo cards
* add support for dark theme
* Add support for custom theme
* repositories
* fix
* make it simpler
* spcaing
* responsive fix
* adds support for usernames
* make it modular
* fix
* show icons
* cache_seconds
* fix
* Revert "cache_seconds"
This reverts commit a9dd4d5d43d212676e1c1dba8ec8086c7fdb7cd7.
* add last line
* fix
* github only
* fix
* Add instructions
* Add `README.md` instructions
* Add `nav_order`
* add jekyll target blank
* Remove manual target blank from everywhere
* Update README.md
* Set ruby version to 3.0.2 in the deploy script
Co-authored-by: Maruan Al-Shedivat <maruan@genesistherapeutics.ai>
When you fork this directory in your local fork, if you remove images from assets, the README file will be broken.
This should fix the README problem, ensuring that images are always up-to-date from the assets folder of the original al-folio folder.
* Added proper instructions in personal webpages
Changed "For personal and organization webpages" part, tried to be as concise as possible, in accordance with: https://github.com/alshedivat/al-folio/issues/209#issuecomment-798849211
* Update README.md
* Update README.md
Co-authored-by: Maruan <alshedivat@users.noreply.github.com>
* Add webpage to academic pages list
* adding panelbear analytics
* added categories for projects and horizontal mode display for projects
* rewrote the code to ensure it works properly with current project definitions
* Style adjustments
Co-authored-by: Maruan Al-Shedivat <alshedivat.maruan@gmail.com>
* Improve support for deploying in out-of-tree locations
* Document how to deploy in an out-of-tree location
* Add vendor to excludes in _config.yml
* Update README.md
Co-authored-by: Maruan Al-Shedivat <alshedivat.maruan@gmail.com>
* Enable preview images on social media
This commit adds support for serving Open Graph meta tags inside the HTML head. When enabled, links to the page on social media will display a preview.
NB: twitter behaves somewhat differently and may require twitter card meta tags in addition to Open Graph.
https://ogp.me/
* Remove trailing whitespaces
* Support page-specific open graph social media previews
* Document open graph support in the readme
* Improve open graph support