diff --git a/README.md b/README.md index 3169b9bfb8a9..3558823ec499 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@
-[![Preview](assets/img/readme_preview/al-folio-preview.png)](https://alshedivat.github.io/al-folio/) +[![Preview](readme_preview/al-folio-preview.png)](https://alshedivat.github.io/al-folio/) **A simple, clean, and responsive [Jekyll](https://jekyllrb.com/) theme for academics.** @@ -244,8 +244,8 @@ For customization details please refer to [CUSTOMIZE.md](CUSTOMIZE.md). This template has a built-in light/dark mode. It detects the user preferred color scheme and automatically switches to it. You can also manually switch between light and dark mode by clicking on the sun/moon icon in the top right corner of the page.

- - + +

--- @@ -256,7 +256,7 @@ There are currently 2 different ways of generating the CV page content. The firs What this means is, if there is no resume data defined in [\_config.yml](_config.yml) and loaded via a json file, it will load the contents of [\_data/cv.yml](_data/cv.yml) as fallback. -[![CV Preview](assets/img/readme_preview/cv.png)](https://alshedivat.github.io/al-folio/cv/) +[![CV Preview](readme_preview/cv.png)](https://alshedivat.github.io/al-folio/cv/) --- @@ -264,7 +264,7 @@ What this means is, if there is no resume data defined in [\_config.yml](_config You can create a people page if you want to feature more than one person. Each person can have its own short bio, profile picture, and you can also set if every person will appear at the same or opposite sides. -[![People Preview](assets/img/readme_preview/people.png)](https://alshedivat.github.io/al-folio/people/) +[![People Preview](readme_preview/people.png)](https://alshedivat.github.io/al-folio/people/) --- @@ -274,7 +274,7 @@ Your publications' page is generated automatically from your BibTex bibliography You can add extra information to a publication, like a PDF file in the [assets/pdf/](assets/pdf/) directory and add the path to the PDF file in the BibTeX entry with the `pdf` field. Some of the supported fields are: `abstract`, `altmetric`, `arxiv`, `bibtex_show`, `blog`, `code`, `dimensions`, `doi`, `eprint`, `html`, `isbn`, `pdf`, `pmid`, `poster`, `slides`, `supp`, `video`, and `website`. -[![Publications Preview](assets/img/readme_preview/publications.png)](https://alshedivat.github.io/al-folio/publications/) +[![Publications Preview](readme_preview/publications.png)](https://alshedivat.github.io/al-folio/publications/) --- @@ -282,7 +282,7 @@ You can add extra information to a publication, like a PDF file in the [assets/p This Jekyll theme implements `collections` to let you break up your work into categories. The theme comes with two default collections: `news` and `projects`. Items from the `news` collection are automatically displayed on the home page. Items from the `projects` collection are displayed on a responsive grid on projects page. -[![Projects Preview](assets/img/readme_preview/projects.png)](https://alshedivat.github.io/al-folio/projects/) +[![Projects Preview](readme_preview/projects.png)](https://alshedivat.github.io/al-folio/projects/) You can easily create your own collections, apps, short stories, courses, or whatever your creative work is. To do this, edit the collections in the [\_config.yml](_config.yml) file, create a corresponding folder, and create a landing page for your collection, similar to `_pages/projects.md`. @@ -296,7 +296,7 @@ You can easily create your own collections, apps, short stories, courses, or wha The theme allows you to create blog posts in the [distill.pub](https://distill.pub/) style: -[![Distill Preview](assets/img/readme_preview/distill.png)](https://alshedivat.github.io/al-folio/blog/2021/distill/) +[![Distill Preview](readme_preview/distill.png)](https://alshedivat.github.io/al-folio/blog/2021/distill/) For more details on how to create distill-styled posts using `` tags, please refer to [the example](https://alshedivat.github.io/al-folio/blog/2021/distill/). @@ -305,8 +305,8 @@ For more details on how to create distill-styled posts using `` tags, pleas **al-folio** supports fast math typesetting through [MathJax](https://www.mathjax.org/) and code syntax highlighting using [GitHub style](https://github.com/jwarby/jekyll-pygments-themes). Also supports [chartjs charts](https://www.chartjs.org/), [mermaid diagrams](https://mermaid-js.github.io/mermaid/#/), and [TikZ figures](https://tikzjax.com/).

- - + +

#### Photos, Audio, Video and more @@ -315,7 +315,7 @@ Photo formatting is made simple using [Bootstrap's grid system](https://getboots

- +

@@ -327,7 +327,7 @@ Photo formatting is made simple using [Bootstrap's grid system](https://getboots **al-folio** uses [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) and [github-profile-trophy](https://github.com/ryo-ma/github-profile-trophy) to display GitHub repositories and user stats on the `/repositories/` page. -[![Repositories Preview](assets/img/readme_preview/repositories.png)](https://alshedivat.github.io/al-folio/repositories/) +[![Repositories Preview](readme_preview/repositories.png)](https://alshedivat.github.io/al-folio/repositories/) Edit the `_data/repositories.yml` and change the `github_users` and `github_repos` lists to include your own GitHub profile and repositories to the `/repositories/` page. diff --git a/_config.yml b/_config.yml index 110b5bdb442c..e00420ba42b5 100644 --- a/_config.yml +++ b/_config.yml @@ -205,20 +205,23 @@ kramdown: # Includes & excludes include: ["_pages"] exclude: - - bin + - "*.yml" + - bin/ - CONTRIBUTING.md - CUSTOMIZE.md - - docker-compose.yml - Dockerfile - FAQ.md - Gemfile - Gemfile.lock - INSTALL.md - LICENSE + - lighthouse_results/ - package.json - package-lock.json + - _pages/about_einstein.md - purgecss.config.js - README.md + - readme_preview/ - vendor keep_files: - CNAME diff --git a/assets/img/readme_preview/al-folio-preview.png b/readme_preview/al-folio-preview.png similarity index 100% rename from assets/img/readme_preview/al-folio-preview.png rename to readme_preview/al-folio-preview.png diff --git a/assets/img/readme_preview/blog.png b/readme_preview/blog.png similarity index 100% rename from assets/img/readme_preview/blog.png rename to readme_preview/blog.png diff --git a/assets/img/readme_preview/code.png b/readme_preview/code.png similarity index 100% rename from assets/img/readme_preview/code.png rename to readme_preview/code.png diff --git a/assets/img/readme_preview/cv.png b/readme_preview/cv.png similarity index 100% rename from assets/img/readme_preview/cv.png rename to readme_preview/cv.png diff --git a/assets/img/readme_preview/dark.png b/readme_preview/dark.png similarity index 100% rename from assets/img/readme_preview/dark.png rename to readme_preview/dark.png diff --git a/assets/img/readme_preview/distill.png b/readme_preview/distill.png similarity index 100% rename from assets/img/readme_preview/distill.png rename to readme_preview/distill.png diff --git a/assets/img/readme_preview/jupyter.png b/readme_preview/jupyter.png similarity index 100% rename from assets/img/readme_preview/jupyter.png rename to readme_preview/jupyter.png diff --git a/assets/img/readme_preview/light.png b/readme_preview/light.png similarity index 100% rename from assets/img/readme_preview/light.png rename to readme_preview/light.png diff --git a/assets/img/readme_preview/math.png b/readme_preview/math.png similarity index 100% rename from assets/img/readme_preview/math.png rename to readme_preview/math.png diff --git a/assets/img/readme_preview/people.png b/readme_preview/people.png similarity index 100% rename from assets/img/readme_preview/people.png rename to readme_preview/people.png diff --git a/assets/img/readme_preview/photos-screenshot.png b/readme_preview/photos-screenshot.png similarity index 100% rename from assets/img/readme_preview/photos-screenshot.png rename to readme_preview/photos-screenshot.png diff --git a/assets/img/readme_preview/projects.png b/readme_preview/projects.png similarity index 100% rename from assets/img/readme_preview/projects.png rename to readme_preview/projects.png diff --git a/assets/img/readme_preview/publications.png b/readme_preview/publications.png similarity index 100% rename from assets/img/readme_preview/publications.png rename to readme_preview/publications.png diff --git a/assets/img/readme_preview/repositories.png b/readme_preview/repositories.png similarity index 100% rename from assets/img/readme_preview/repositories.png rename to readme_preview/repositories.png