I decided to break the README file into different ones to declutter it
from the main page. Also adding some more explanation on the structure
of the template. Tackling #2032 and #2033
---------
Signed-off-by: George Araujo <george.gcac@gmail.com>
I had added -strip arg to the imagemagick call as it is generally
desirable to strip metadata from images before publishing them, however
it seems to occasionally cause issues with jekyll-imagemagick
auto-regeneration, regenerating images even when they have not changed.
Fixes#1967
Update the way responsive images are used to only use one srcset, and
add corresponding `sizes` attribute to the relevant layouts and
templates.
I did not go through and add `sizes` to all the example posts/projects.
When `sizes` is not specified by the user, the `figure.html` template
defaults to 95% the width of the viewport which should work fine for
most cases; users can optimize further if they wish by feeding `sizes`
into the template.
Additionally:
- Enabled support for .gif to .webp compression
- fix error in jekyll-imagemagick config where all images were resized
to be 800px or less. (for example img-1400.webp was actually only 800px
wide, etc.)
- added note about making sure imagemagick is installed before enabling
it in responsive images section of `_config.yml`
After deploying my website (Cloudflare Pages), my Giscus did not work, I
realized these two paramesters are removed. After adding them again, my
Giscus worked correctly.
These new values are values from previous commits of original repository
---------
Co-authored-by: Maruan Al-Shedivat <maruan@genesistherapeutics.ai>
When the video entry is added to bib:
e.g.,
```
{
...
video={https://www.youtube.com/embed/jNQXAC9IVRw}
...
}
```
A dedicated button appears for videos. When clicked, a playable video
appears under the research article (like abstracts and bibtex)
Fixes#1952 by updating font awesome version. Also updated icons names
to newest font awesome style.
---------
Signed-off-by: George Araujo <george.gcac@gmail.com>
giscus settings in `_config.yml` had al-folio repo specified by default.
many users kept these defaults in their own repos, which resulted in
getting comments from blog posts of different users posted to al-folio
discussions. this is undesirable, since users lose control over the
discussions in their blogs.
this PR solves the issue:
- first, we set `giscus.repo` to blank in `_config.yml`. if the field is
kept blank, when the website is built locally, the user will see a
warning saying that giscus comments are misconfigured.
- second, we add a step to the `deploy` workflow that writes repository
name to `giscus.repo` in `_config.yml`. that way, even if `giscus.repo`
field is left black or set to an incorrect repo, it gets correctly
populated at deployment time.
other small changes in this PR are small stylistic adjustments.
Tackled #1329 with [PurgeCSS](https://purgecss.com/).
Being talking with @varuniyer about using
[jekyll-uncss](https://github.com/episource/jekyll-uncss) to reduce css
file sizes by ditching unused classes. This approach have 3 main
problems:
1 - have some limitations as pointed
[here](https://github.com/alshedivat/al-folio/issues/1329#issuecomment-1546517327)
2 - last update to
[jekyll-uncss](https://github.com/episource/jekyll-uncss) was about 3
years ago, so it might have a few issues
3 - [uncss](https://github.com/uncss/uncss) haven't seem a new release
in a while, currently [lacking
maintenance](https://github.com/uncss/uncss/issues/459), and using some
deprecated libraries as seem here:
```
npm install -g uncss
npm WARN deprecated request-promise-native@1.0.9: request-promise-native has been deprecated because it extends the now deprecated request package, see https://github.com/request/request/issues/3142
npm WARN deprecated har-validator@5.1.5: this library is no longer supported
npm WARN deprecated w3c-hr-time@1.0.2: Use your platform's native performance.now() and performance.timeOrigin.
npm WARN deprecated uuid@3.4.0: Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.
npm WARN deprecated request@2.88.2: request has been deprecated, see https://github.com/request/request/issues/3142
```
I thought about giving PurgeCSS a go, since it has been more [actively
maintaned](https://github.com/FullHuman/purgecss), but
[jekyll-purgecss](https://github.com/mhanberg/jekyll-purgecss) haven't.
For this, I needed to change to use some local libraries instead of
getting them via CDN. The good news is that it is quite effective in
reducing css file sizes. Comparing dir sizes with `du -hs
_site/assets/css/`:
| current | minify | PurgeCSS | PurgeCSS + minify |
| ------- | ------ | -------- | ----------------- |
| 1,1M | 988K | 456K | 420K |
---------
Signed-off-by: George Araujo <george.gcac@gmail.com>
When the WeChat icon in socials is clicked, a picture of your WeChat QR
code is shown in the center of the screen. The actual picture of your QR
code has to be uploaded.
#1569 Fixed mismatch between zotero-id in _config.yml and the zotero-id
called upon in the socials html file introduced by #1572 (sorry about
that; slipped in when I had to reset my zotero-branch)
Solving #1569
I added Zotero socials because I needed them; opened a issue/pull
request in case I'm not the only one.
Second pull request (previous: #1570 ) because unwanted commits
retroactively crept in somehow. It was easier to force reset (which
closed the pull request automatically apparently).
Just as discussed in #1513 , this pull request adds support for
[jsonresume](https://jsonresume.org/). Create the resume once, either as
a file in the repository or at [github gist](https://gist.github.com/)
called `resume.json`. Put the file in the `_config.yaml` file and that's
it! Other platforms like [resumake](https://latexresu.me/) use the same
schema.
I also incorperated the changes introduced by #1339 to the best of my
abilites. The style could be further improved.
**Please merge this pull request after #1339 is merged, due to
dependencies from it**
If someone has a bettet approach on how to solve the problem that each
section needs its own template, please let me know. But for now it works
fine and is still backwards compatible with the `cv.yaml` file.
Co-authored-by: George <31376482+george-gca@users.noreply.github.com>
[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.
This feature adds a horizontal bar under the top menu which tracks the
vertical scroll position. Such a feature can be useful to represent how
much is left to read on the current page more aesthetically.
As this is an optional feature, `enable_progressbar` must be set to
`true` in `_config.yml` to activate the functionality.
I am not the original author of this code. I just made it compatible
with the current version of the template at the time of this commit. The
original code was most likely authored by Pankaj Parashar in this
[post](https://css-tricks.com/reading-position-indicator/) made a few
years before the first inclusion in an `al-folio` site. Then, the code
was adapted for compatibility with the template at Anthony Plantanios'
site. Finally, I did
the last updates to have the code fit the new conventions used in the
project.
This was discussed in #557
Co-authored-by: rohandebsarkar <rohandebsarkar@gmail.com>
#877 is an explanation of the issue. The new icons include Kaggle,
LastFM, Spotify, Pinterest, Unsplash, Instagram, and Facebook, and you
can change their order.
* 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`
* Adds support max author limit
* typo
* fix
* display all authors by default
* Added an example
* Added 'and' before the last author
* Improve hiding/showing more authors
* Add title text
Co-authored-by: Maruan Al-Shedivat <maruan@genesistherapeutics.ai>
Co-authored-by: Maruan <alshedivat@users.noreply.github.com>
This PR replaces the jekyll-responsive-images with jekyll-imagemagick for responsive WebP images.
WebP images are much smaller compared to PNG and JPEG, faster to load and most of the modern browsers recommend it.
More information about WebP images: https://developers.google.com/speed/webp
* 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
* added blockquote format, jekyll-archives, tag, year archive pages, and reading time.
* added archive meta to blog posts list and individual posts.
* added sitemap
* stylistic modifications to jekyll-archive addition
* Minor fixes
Co-authored-by: Maruan Al-Shedivat <alshedivat.maruan@gmail.com>
* 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>
* Revert "Fix latex rendering issue in the bibliography entries (#358)"
This reverts commit e328dc6abe.
* Update mathjax version to 3.2.0
* Add bibtex_filters explicitly to _config.yml
* 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>
