diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..dd84ea7824f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..bbcbbe7d615 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.gitignore b/.gitignore index bd5d18888f2..5c531a00105 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,13 @@ +# Ignore the contents of the _site directory and other cache directories _site/ +.sass-cache/ +# Ignore the directory for local files during development +local/ + +# Ignore the Gemfile that is generated +Gemfile.lock + +# Ingore files created by npm +node_modules +package-lock.json \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 291bc736493..00000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,484 +0,0 @@ -## [3.4.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.4.2) - -### Enhancements - -- Improve UX of static comment forms. [#448](https://github.com/mmistakes/minimal-mistakes/issues/448) - -## [3.4.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.4.1) - -### Enhancements - -- Add `staticman.filename` configuration with UNIX timestamp for sorting data files. example ~> `comment-1470943149`. - -### Bug Fixes - -- Don't add `` to author name if URL is blank. - -## [3.4.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.4.0) - -### Enhancements - -- Support static-based commenting via [Staticman](https://staticman.net/) for sites hosted with GitHub Pages. [#424](https://github.com/mmistakes/minimal-mistakes/issues/424) - -## [3.3.7](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.3.7) - -### Bug Fixes - -- Re-enabled Jekyll plugins in `_config.yml` in case they aren't autoloaded in `Gemfile`. [#417](https://github.com/mmistakes/minimal-mistakes/issues/417) - -### Enhancements - -- Fallback to `site.github.url` for use in `{{ base_path }}` when `site.url` is `nil`. -- Replace Sass and Autoprefixer `npm` build scripts with [Jekyll's built-in asset support](https://jekyllrb.com/docs/assets/). [#333](https://github.com/mmistakes/minimal-mistakes/issues/333) - -### Maintenance - -- Document `site.repository` and its role with [`github-metadata`](https://github.com/jekyll/github-metadata) gem. -- Add sample [archive page with content](https://mmistakes.github.io/minimal-mistakes/archive-layout-with-content/) for testing styles on demo site. - -## [3.3.6](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.3.6) - -### Bug Fixes - -- Fix blank `site.teaser` bug. [#412](https://github.com/mmistakes/minimal-mistakes/issues/412) - -## [3.3.5](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.3.5) - -### Enhancements - -- Add English default text `site.locale` strings. [#407](https://github.com/mmistakes/minimal-mistakes/issues/407) -- Add Portuguese localized UI text. [#411](https://github.com/mmistakes/minimal-mistakes/pull/411) -- Add Italian localized UI text. [#409](https://github.com/mmistakes/minimal-mistakes/pull/409) - -### Maintenance - -- Remove unused Google AdSense variables in `_config.yml`. [#404](https://github.com/mmistakes/minimal-mistakes/issues/404) -- Update `Gemfile` instructions for using `github-pages` vs. native `jekyll` gems. -- Disable `gems:` in `_config.yml` and enable plugins with Bundler instead. -- Add `repository` to `_config.yml` to suppress GitHub Pages error `Liquid Exception: No repo name found.` - -## [3.3.4](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.3.4) - -### Enhancements - -- Add support for configurable feed URL to use a service like FeedBurner instead of linking directly to `feed.xml` in `` and the site footer. [#378](https://github.com/mmistakes/minimal-mistakes/issues/378), [#379](https://github.com/mmistakes/minimal-mistakes/pull/379), [#406](https://github.com/mmistakes/minimal-mistakes/pull/406) -- Add Turkish localized UI text. [#403](https://github.com/mmistakes/minimal-mistakes/pull/403) - -### Maintenance - -- Update gems: `activesupport` (4.2.7), `ffi` (1.9.14), `github-pages` (88), `jekyll-redirect-from` (0.11.0), `jekyll-watch` (1.5.0). - -## [3.3.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.3.3) - -### Enhancements - -- Make footer stick to the bottom of the page. - -### Bug Fixes - -- Fix `gallery` size bug [#402](https://github.com/mmistakes/minimal-mistakes/issues/402) - -### Maintenance - -- Set default `lang` to `en`. - -## [3.3.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.3.2) - -### Bug Fixes - -- Fix JavaScript that triggers "sticky" sidebar to avoid layout issues on screen sizes < `1024px`. [#396](https://github.com/mmistakes/minimal-mistakes/issues/396) - -## [3.3.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.3.1) - -### Enhancements - -- Enable image popup on < 500px wide screens. [#385](https://github.com/mmistakes/minimal-mistakes/issues/385) -- Indicate the relationship between component URLs in a paginated series by applying `rel="prev"` and `rel="next"` to pages that use `site.paginator`. [#253](https://github.com/mmistakes/minimal-mistakes/issues/253) -- Improve link posts in archive listings. [#276](https://github.com/mmistakes/minimal-mistakes/issues/276) - -### Maintenance - -- Update gems: `github-pages` (86), `ffi` 1.9.13, `jekyll-mentions` 1.1.3, and `rouge` 1.11.1 -- Fix note about custom sidebar content appearing below author profile. [#388](https://github.com/mmistakes/minimal-mistakes/issues/388) - -## [3.2.13](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.13) - -### Enhancements - -- Add English default UI text for Canada, Great Britain, and Australia. [#377](https://github.com/mmistakes/minimal-mistakes/issues/377) -- Switch default locale from `en-US` to `en`. - -## [3.2.12](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.12) - -### Enhancements - -- Remove window width "magic number" from sticky sidebar check in `main.js` for improved flexibility. [#375](https://github.com/mmistakes/minimal-mistakes/pull/375) - -### Bug Fixes - -- Fix author override conditional where a missing `authors.yml` would show broken sidebar content. Defaults to `site.author`. [#376](https://github.com/mmistakes/minimal-mistakes/pull/376) - -## [3.2.11](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.11) - -### Bug Fixes - -- Fix disappearing author sidebar links [#372](https://github.com/mmistakes/minimal-mistakes/issues/372) - -### Maintenance - -- Update gems: `github-pages` (84), `jekyll-github-metadata` 2.0.2, and `kramdown` 1.11.1 -- Update vendor JavaScript: jQuery 1.12.4, Stickyfill.js 1.1.4 -- Update Font Awesome 4.6.3 - -## [3.2.10](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.10) - -### Maintenance - -- Add `CONTRIBUTING.md` - -## [3.2.9](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.9) - -### Enhancements - -- Add support for [header overlay images](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#header-overlay) for Open Graph images. [#358](https://github.com/mmistakes/minimal-mistakes/pull/358) - -### Bug Fixes - -- Fix `Person` typo Schema.org type [#358](https://github.com/mmistakes/minimal-mistakes/pull/358) - -### Maintenance - -- Update `github-pages` gem and dependencies. -- Remove `minutes_read` to avoid awkward reading time wording [#356](https://github.com/mmistakes/minimal-mistakes/issues/356) - -## [3.2.8](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.8) - -### Bug Fixes - -- Remove `cursor: pointer` that appears on white-space surrounding author side list items and links. [#354](https://github.com/mmistakes/minimal-mistakes/pull/354) - -### Maintenance - -- Add contributing information to `README.md`. [#357](https://github.com/mmistakes/minimal-mistakes/issues/357) - -## [3.2.7](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.7) - -### Enhancements - -- Add French localized UI text. [#346](https://github.com/mmistakes/minimal-mistakes/pull/346) - -### Bug Fixes - -- Fix branch logic for Yandex and Alexa in `seo.html`. [#348](https://github.com/mmistakes/minimal-mistakes/pull/348) - -## [3.2.6](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.6) - -### Bug Fixes - -- Fix error `Liquid Exception: divided by 0 in _includes/archive-single.html, included in _layouts/single.html` caused by null `words_per_minute` in `_config.yml`. [#345](https://github.com/mmistakes/minimal-mistakes/pull/345) - -## [3.2.5](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.5) - -### Bug Fixes - -- Fix link color in hero overlay to be white. -- Remove underlines from archive item titles. - -## [3.2.4](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.4) - -### Enhancements - -- Improve text alignment of masthead, hero overlay, page footer to be flush left and remove awkward white-space gaps. [#342](https://github.com/mmistakes/minimal-mistakes/issues/342) -- Add Spanish localized UI text. [#338](https://github.com/mmistakes/minimal-mistakes/pull/338) - -### Bug Fixes - -- Fix alignment of icons in author sidebar [#341](https://github.com/mmistakes/minimal-mistakes/issues/341) - -### Maintenance - -- Add background color to page footer to set it apart from main content. [#342](https://github.com/mmistakes/minimal-mistakes/issues/342) -- Add terms and privacy policy to theme's demo site. [#343](https://github.com/mmistakes/minimal-mistakes/issues/343) -- Update screenshots found in theme documentation. - -## [3.2.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.3) - -### Enhancements - -- Add [Discourse](https://www.discourse.org/) as a commenting provider. [#335](https://github.com/mmistakes/minimal-mistakes/pull/335) - -## [3.2.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.2) - -### Enhancements - -- Add support for image captions in Magnific Popup overlays via the [`gallery`](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#gallery) helper. [#334](https://github.com/mmistakes/minimal-mistakes/issues/334) - -## [3.2.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.1) - -### Bug Fixes - -- Remove need for "double tapping" masthead menu links on iOS devices. [#315](https://github.com/mmistakes/minimal-mistakes/issues/315) - -### Maintenance - -- Add `ISSUE_TEMPLATE.md` for improve issue submission process. - -## [3.2.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.2.0) - -### Bug Fixes - -- Fix missing category/tag links in post footer due to possible conflict with `site.tags` and `site.categories`. [#329](https://github.com/mmistakes/minimal-mistakes/issues/329#issuecomment-222375568) - -## [3.1.8](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.8) - -### Bug Fixes - -- Fix `Liquid Exception: undefined method 'gsub' for nil:NilClass in _layouts/single.html` error when `page.title` is null. `

` element is now conditional if `title: ` is not set for a `page` or collection item. [#312](https://github.com/mmistakes/minimal-mistakes/issues/312) - -### Maintenance - -- Remove duplicate `fa-twitter` and `fa-twitter-square` classes from `_utilities.scss`. [#302](https://github.com/mmistakes/minimal-mistakes/issues/302) - -- Document installing additional Jekyll gem dependencies when using `gem "jekyll"` instead of `gem "github-pages"` to avoid any errors on run. [#305](https://github.com/mmistakes/minimal-mistakes/issues/305) - -## [3.1.7](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.7) - -### Enhancements - -- Add translation key for "Recent Posts" used in home page `index.html`. [#316](https://github.com/mmistakes/minimal-mistakes/pull/316) - -### Maintenance - -- Small fix to avoid underlying the whitespace between icons and related text when hovering. [#303](https://github.com/mmistakes/minimal-mistakes/pull/303) - -## [3.1.6](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.6) - -### Maintenance - -- Update gem dependencies. Run `bundle` to update `Gemfile.lock`. - -## [3.1.5](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.5) - -### Maintenance - -- Fix `www` and `https` links in author profile include [#293](https://github.com/mmistakes/minimal-mistakes/pull/293) - -## [3.1.4](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.4) - -### Enhancements - -- Add overlay_filter param to hero headers [#298](https://github.com/mmistakes/minimal-mistakes/pull/298) - -## [3.1.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.3) - -### Enhancements - -- Improve `site.locale` documentation [#284](https://github.com/mmistakes/minimal-mistakes/issues/284) -- Remove ProTip note about protocol-less `site.url` as it is an anti-pattern [#288](https://github.com/mmistakes/minimal-mistakes/issues/288) - -### Bug Fixes - -- Fix `og_image` URL in seo.html [#277](https://github.com/mmistakes/minimal-mistakes/issues/277) -- Fix `author_profile` toggle when assigned in a `_layout` [#285](https://github.com/mmistakes/minimal-mistakes/issues/285) -- Fix typo in `build:all` npm script [#283](https://github.com/mmistakes/minimal-mistakes/pull/283) -- Fix URL typo documentation [#287](https://github.com/mmistakes/minimal-mistakes/issues/287) -- SEO author bug. If `twitter.username` is set and `author.twitter` is `nil` bad things happen. [#289](https://github.com/mmistakes/minimal-mistakes/issues/289) - -## [3.1.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.2) - -### Enhancements - -- Explain how to use `nav_list` helper in [documentation](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#navigation-list). -- Reduce left/right padding on smaller screens to increase width of main content column. - -### Bug Fixes - -- Fix alignment issues with related posts [#273](https://github.com/mmistakes/minimal-mistakes/issues/273) and "Follow" button in author profile [#274](https://github.com/mmistakes/minimal-mistakes/issues/274). - -## [3.1.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.1) - -### Bug Fix - -- Fixed reading time bug when `words_per_minute` wasn't set in `_config.yml` [#271](https://github.com/mmistakes/minimal-mistakes/issues/271) - -## [3.1.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.1.0) - -### Enhancements - -- Updated [Font Awesome](https://fortawesome.github.io/Font-Awesome/whats-new/) to version 4.6.1 -- Added optional GitHub and Bitbucket links to footer if set on `site.author` in `_config.yml`. - -### Bug Fixes -- Fixed Bitbucket URL typo in author sidebar. - -## [3.0.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/3.0.3) - -### Enhancements - -- Rebuilt the entire theme: layouts, includes, stylesheets, scripts, you name it. -- Refreshed the look and feel while staying true to the original design of the theme (author sidebar/main content). -- Replaced grid system with [Susy](http://susy.oddbird.net/). -- Replaced Grunt tasks with `npm` scripts. -- Removed Google Fonts and replaced with system fonts to improve performance (they can be [added back](https://mmistakes.github.io/minimal-mistakes/docs/stylesheets/) if desired) -- Greatly improved [theme documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/). -- Increased the amount of sample posts, sample pages, and sample collections to throughly test the theme and edge-cases. -- Moved all sample content and assets out of `master` to keep it as clean as possible for forking. -- Added new layouts for `splash` pages, archives for [`jekyll-archives`](https://github.com/jekyll/jekyll-archives) if enabled, and [`compress.html`](https://github.com/penibelst/jekyll-compress-html) to improve performance. -- Added taxonomy links to posts (tags and categories). -- Added optional "reading time" meta data. -- Improved Liquid used for Twitter Cards and Open Graph data in ``. -- Improved `gallery` include helper and added `feature_row` for use with splash page layout. -- Added Keybase.io, author web URI, and Bitbucket optional links to sidebar. -- Add `feed.xml` link to footer. -- Added a [UI text data file](https://mmistakes.github.io/minimal-mistakes/docs/ui-text/) to easily change all text found in the theme. -- Added LinkedIn to optional social share buttons. -- Added Facebook, Google+, and custom commenting options in addition to Disqus. -- Added optional breadcrumb links. - -## [2.2.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.2.1) - -## [2.2.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.2.0) - -### Enhancements - -- Add support for Jekyll 3.0 -- Minor updates to syntax highlighting CSS and theme documentation - -## [2.1.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.1.3) - -### Enhancements - -- Cleaner print styles that remove the top navigation, social sharing buttons, and other elements not needed when printed. - -## [2.1.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.1.2) - -### Enhancements - -- Add optional CodePen icon/url to author side bar [#156](https://github.com/mmistakes/minimal-mistakes/pull/156) -- Documented Stackoverflow username explanation in `_config.yml` [#157](https://github.com/mmistakes/minimal-mistakes/pull/157) -- Simplified Liquid in `post-index.html` to better handle year listings [#166](https://github.com/mmistakes/minimal-mistakes/pull/166) - -### Bug Fixes - -- Cleanup Facebook related Open Graph meta tags [#149](https://github.com/mmistakes/minimal-mistakes/issues/149) -- Corrected minor typos [#158](https://github.com/mmistakes/minimal-mistakes/pull/158) [#175](https://github.com/mmistakes/minimal-mistakes/issues/175) - -## [2.1.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.1.1) - -### Enhancements - -- Add optional XING profile link to author sidebar -- Include open graph meta tags for feature image (if assigned) [#149](https://github.com/mmistakes/minimal-mistakes/issues/149) -- Create an include for feed footer - -### Bug Fixes - -- Remove http protocol from Google search form on sample 404 page -- Only show related posts if there are one or more available -- Fix alignment of email address link in author sidebar - -## [2.1.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.1.0) - -### Enhancements - -- Add optional social sharing buttons ([#42](https://github.com/mmistakes/minimal-mistakes/issues/42)) - -![social sharing buttons](https://cloud.githubusercontent.com/assets/1376749/5860522/d9f28a96-a22f-11e4-9b83-940a3a9a766a.png) - -- Add Soundcloud, YouTube ([#95](https://github.com/mmistakes/minimal-mistakes/pull/95)), Flickr ([#119](https://github.com/mmistakes/minimal-mistakes/pull/119)), and Weibo ([#116](https://github.com/mmistakes/minimal-mistakes/pull/116)) icons for use in author sidebar. -- Fix typos in posts and documentation and remove references to Less -- Include note about Octopress gem being optional -- Post author override support extended to the Atom feed ([#71](https://github.com/mmistakes/minimal-mistakes/pull/71)) -- Only include email address in feed if specified in `_config.yml` or author `_data` -- Wrap all page content in `#main` to harmonize article and post index styles ([#86](https://github.com/mmistakes/minimal-mistakes/issues/86)) -- Include new sample feature images for posts and pages -- Table of contents improvements: fix collapse toggle, indent nested elements, show on small screens, and create an `_include` for reusing in posts and pages. -- Include note about running Jekyll with `bundle exec` when using Bundler -- Fix home page path in top navigation -- Remove Google Authorship ([#120](https://github.com/mmistakes/minimal-mistakes/issues/120)) -- Remove duplicate author content that displayed in `div.article-author-bottom` -- Removed unused `_sass/print.scss` styles -- Improve comments in `.scss` files - -## [2.0.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/v2.0) - -## [1.3.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.3.3) - -### Enhancements - -- Added new icons and profile links for Stackoverflow, Dribbble, Pinterest, Foursquare, and Steam to the author bio sidebar. -- Cleaned up the Kramdown auto table of contents styling to be more readable -- Removed page width specific .less stylesheets and created mixins for easier updating -- Removed Modernizr since it wasn't being used -- Added pages to sitemap.xml -- Added category: to rake new_post task -- Minor typographic changes - -### Bug Fixes - -- Corrected various broken links in README and Theme Setup. - -## [1.3.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.3.1) - -### Enhancements - -- Cleaned up table of contents styling -- Reworked top navigation to be a better experience on small screens. Nav items now display vertically when the menu button is tapped, revealing links with larger touch targets. - -![menu animation](https://camo.githubusercontent.com/3fbd8c1326485f4b1ab32c0005c0fca7660b5d31/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f313337363734392f323136343037352f31653366303663322d393465372d313165332d383961612d6436623636376562306564662e676966) - -## [1.2.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.2.0) - -### Bug Fixes - -- Table weren't filling the entire width of the content container. They now scale at 100%. Thanks [@dhruvbhatia](https://github.com/dhruvbhatia) - -### Enhancements - -- Decreased spacing between Markdown footnotes -- Removed dark background on footer -- Removed UPPERCASE styling on post titles in the index listing - -## [1.1.4](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.4) - -### Bug Fixes - -- Fix top navigation bug issue ([#10](https://github.com/mmistakes/minimal-mistakes/issues/10)) for real this time. Remember to clear your floats kids. - -## [1.1.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.3) - -### Bug Fixes - -- Fix top navigation links that weren't click able on small viewports (Issue [#10](https://github.com/mmistakes/minimal-mistakes/issues/10)). -- Remove line wrap from top navigation links that may span multiple lines. - -## [1.1.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.2) - -### Enhancements - -- Added Grunt build script for compiling Less/JavaScript and optimizing image assets. -- Added support for large image summary Twitter card. -- Stylesheet adjustments - -## [1.1.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.1) - -### Bug Fixes - -- Removed [Typeplate](http://typeplate.com/) styles. Was [causing issues with newer versions of Less](https://github.com/typeplate/typeplate.github.io/issues/108) and is no longer maintained. - -### Enhancements - -- Added [image attribution](http://mmistakes.github.io/minimal-mistakes/theme-setup/#feature-images) for post and page feature images. -- Added [404 page](http://mmistakes.github.io/minimal-mistakes/404.html). -- Cleaned up various Less variables to better align with naming conventions used in other MM Jekyll themes. -- Removed Chrome Frame references. -- Added global CSS3 transitions to text and block elements. -- Improved typography in a few places. - -## [1.0.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/v1.0.2) - -### Enhancements - -- Google Analytics, Google Authorship, webmaster verifies, and Twitter card meta are now optional. - -## [1.0.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/v1.0.1) \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 803b63d8571..23c50b425a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,8 @@ -Contributions are welcome! Please add issues and make pull requests. There are no stupid questions. All ideas are welcome. This is a volunteer project. Be excellent to each other. +Contributions are welcome! -Fork from master and go from there. This repository is intended to remain a generic, ready-to-fork template that demonstrates the features of academicpages. +Please add issues and make pull requests. There are no stupid questions. All ideas are welcome. This is a volunteer project. Be excellent to each other. + +Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions). + +Fork from master and go from there. Remember that this repository is intended to remain a generic, ready-to-fork template that demonstrates the features of academicpages. -If you make a pull request and change code, please make sure there is a closed issue tagged with 'code change' that has some comment linking to either the single commit (if the change was just one commit) or a diff comparing before/after the change (see [issue 21](https://github.com/academicpages/academicpages.github.io/issues/21) for example). This is so that those who have forked this repo and modified it for their purposes can more easily patch bugs and new features. diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000000..983dea15d0f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,24 @@ +# Base image: Ruby with necessary dependencies for Jekyll +FROM ruby:3.2 + +# Install dependencies +RUN apt-get update && apt-get install -y \ + build-essential \ + nodejs \ + && rm -rf /var/lib/apt/lists/* + +# Set the working directory inside the container +WORKDIR /usr/src/app + +# Copy Gemfile into the container (necessary for `bundle install`) +COPY Gemfile ./ + +# Install bundler and dependencies +RUN gem install bundler:2.3.26 && bundle install + +# Expose port 4000 for Jekyll server +EXPOSE 4000 + +# Command to serve the Jekyll site +CMD ["bundle", "exec", "jekyll", "serve", "--host", "0.0.0.0", "--watch"] + diff --git a/Gemfile b/Gemfile index 1629566cf41..a430da00214 100644 --- a/Gemfile +++ b/Gemfile @@ -1,27 +1,12 @@ -source "https://rubygems.org" +source 'https://rubygems.org' -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! - -gem "github-pages", group: :jekyll_plugins - -# If you want to use Jekyll native, uncomment the line below. -# To upgrade, run `bundle update`. - -# gem "jekyll" - -gem "wdm", "~> 0.1.0" if Gem.win_platform? - -# If you have any plugins, put them here! group :jekyll_plugins do - # gem "jekyll-archives" - gem "jekyll-feed" + gem 'jekyll' + gem 'jekyll-feed' gem 'jekyll-sitemap' - gem 'hawkins' + gem 'jekyll-redirect-from' + gem 'jemoji' + gem 'webrick', '~> 1.8' end + +gem 'github-pages' diff --git a/README.md b/README.md index 7736cd10d07..e71884eb3a4 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,77 @@ -A Github Pages template for academic websites. This was forked (then detached) by [Stuart Geiger](https://github.com/staeiou) from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/), which is © 2016 Michael Rose and released under the MIT License. See LICENSE.md. +# Academic Pages +**Academic Pages is a Github Pages template for academic websites.** -I think I've got things running smoothly and fixed some major bugs, but feel free to file issues or make pull requests if you want to improve the generic template / theme. +![Academic Pages template example](images/homepage.png "Academic Pages template example") -### Note: if you are using this repo and now get a notification about a security vulnerability, delete the Gemfile.lock file. - -# Instructions +# Getting Started 1. Register a GitHub account if you don't have one and confirm your e-mail (required!) -1. Fork [this repository](https://github.com/academicpages/academicpages.github.io) by clicking the "fork" button in the top right. -1. Go to the repository's settings (rightmost item in the tabs that start with "Code", should be below "Unwatch"). Rename the repository "[your GitHub username].github.io", which will also be your website's URL. -1. Set site-wide configuration and create content & metadata (see below -- also see [this set of diffs](http://archive.is/3TPas) showing what files were changed to set up [an example site](https://getorg-testacct.github.io) for a user with the username "getorg-testacct") -1. 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. +1. Click the "Use this template" button in the top right. +1. On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL. +1. Set site-wide configuration and add your content. +1. 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. 1. Check status by going to the repository settings, in the "GitHub pages" section 1. (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/ -## To run locally (not on GitHub Pages, to serve on your own computer) +## 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: -1. Clone the repository and made updates as detailed above -1. Make sure you have ruby-dev, bundler, and nodejs installed: `sudo apt install ruby-dev ruby-bundler nodejs` -1. Run `bundle clean` to clean up the directory (no need to run `--force`) +1. Clone the repository and made updates as detailed above. +1. Make sure you have ruby-dev, bundler, and nodejs installed + + On most Linux distribution and [Windows Subsystem Linux](https://learn.microsoft.com/en-us/windows/wsl/about) the command is: + ```bash + sudo apt install ruby-dev ruby-bundler nodejs + ``` + On MacOS the commands are: + ```bash + brew install ruby + brew install node + gem install bundler + ``` 1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again. -1. Run `bundle exec jekyll liveserve` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change. +1. 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-essential gcc make` + +## Using Docker + +Working from a different OS, or just want to avoid installing dependencies? You can use the provided `Dockerfile` to build a container that will run the site for you if you have [Docker](https://www.docker.com/) installed. + +Start by build the container: + +```bash +docker build -t jekyll-site . +``` + +Next, run the container: +```bash +docker run -p 4000:4000 --rm -v $(pwd):/usr/src/app jekyll-site +``` + +# Maintenance + +Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions). + +This repository was forked (then detached) by [Stuart Geiger](https://github.com/staeiou) from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/), which is © 2016 Michael Rose and released under the MIT License (see LICENSE.md). It is currently being maintained by [Robert Zupko](https://github.com/rjzupkoii) 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repository as opposed to using it as a template. This will also allow you to [synchronize your copy](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) of template to your fork as well. -# Changelog -- bugfixes and enhancements +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. -There is one logistical issue with a ready-to-fork template theme like academic pages that makes it a little tricky to get bug fixes and updates to the core theme. If you fork this repository, customize it, then pull again, you'll probably get merge conflicts. 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. +--- +
+ +![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg) +[![GitHub contributors](https://img.shields.io/github/contributors/academicpages/academicpages.github.io.svg)](https://github.com/academicpages/academicpages.github.io/graphs/contributors) +[![GitHub release](https://img.shields.io/github/v/release/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/releases/latest) +[![GitHub license](https://img.shields.io/github/license/academicpages/academicpages.github.io?color=blue)](https://github.com/academicpages/academicpages.github.io/blob/master/LICENSE) -To support this, all changes to the underlying code appear as a closed issue with the tag 'code change' -- get the list [here](https://github.com/academicpages/academicpages.github.io/issues?q=is%3Aclosed%20is%3Aissue%20label%3A%22code%20change%22%20). Each issue thread includes a comment linking to the single commit or a diff across multiple commits, so those with forked repositories can easily identify what they need to patch. +[![GitHub stars](https://img.shields.io/github/stars/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io) +[![GitHub forks](https://img.shields.io/github/forks/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/fork) +
diff --git a/_config.dev.yml b/_config.dev.yml deleted file mode 100644 index 45df3dfe29a..00000000000 --- a/_config.dev.yml +++ /dev/null @@ -1,13 +0,0 @@ -# Develop override settings - -url: http://localhost:4000 - -analytics: - provider: false - -comments: - disqus: - shortname : "mmistakes-dev" - -sass: - style: expanded \ No newline at end of file diff --git a/_config.yml b/_config.yml index 1dc605cc6e9..b2d8f0e638f 100644 --- a/_config.yml +++ b/_config.yml @@ -3,17 +3,87 @@ # This config file is meant for settings that affect your entire site, values # which you are expected to set up once and rarely need to edit after that. # For technical reasons, this file is *NOT* reloaded automatically when you use -# `jekyll serve`. If you change this file, please restart the server process. +# `jekyll serve -l -H localhost`. If you change this file, please restart the +# server process. -# Site Settings +# Basic Site Settings locale : "en-US" title : "Your Name / Site Title" title_separator : "-" -name : &name "Your Name" +name : &name "Hongye Zhao 赵宏烨" description : &description "personal description" -url : https://academicpages.github.io # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" +url : https://academicpages.github.io # the base hostname & protocol for your site e.g. "https://[your GitHub username].github.io" baseurl : "" # the subpath of your site, e.g. "/blog" repository : "academicpages/academicpages.github.io" + +# Site Author - The following control what appear as part of the author content on the side bar. +# If a field is blank the icon and link will not appear, otherwise it will be shown. +# Additional customization can be done by editing /_includes/author-profile.html +author: + # Biographic information + avatar : "profile.png" + name : "Your Sidebar Name" + pronouns : # example: "she/her" + bio : "Short biography for the left-hand sidebar" + location : "Earth" + employer : "Red Brick University" + uri : # URL + email : "none@example.org" + + # Academic websites + arxiv : # URL - Update with the correct link to your profile + googlescholar : "https://scholar.google.com/citations?user=PS_CX0AAAAAJ" + impactstory : # URL + orcid : "http://orcid.org/yourorcidurl" + semantic : # URL + pubmed : "https://www.ncbi.nlm.nih.gov/pubmed/?term=john+snow" + researchgate : # URL + scopus : # URL + + # Repositories and software development + bitbucket : # Username - Update with your username on the site + codepen : # Username + dribbble : # Username + github : "academicpages" + kaggle : # Username + stackoverflow : # User number or user number and name (i.e., use "1" or "1/jeff-atwood") + + # Social media + bluesky : "bsky.app" # Replace this with you Bluesky username + facebook : # Username + flickr : # Username + foursquare : # Username + goodreads : # Username + google_plus : # Username + keybase : # Username + instagram : # Username + lastfm : # Username + linkedin : # Username + mastodon : # URL + medium : # URL + pinterest : # Username + soundcloud : # Username + steam : # Username + telegram : # URL + tumblr : # Username + twitter : # Username for X / Twitter + vine : # Username + weibo : # Username + wikipedia : # Username + xing : # Username + youtube : # Username + zhihu : # Username + +# Publication Category - The following the list of publication categories and their headings +publication_category: + books: + title: 'Books' + manuscripts: + title: 'Journal Articles' + conferences: + title: 'Conference Papers' + +# Site Settings teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png" breadcrumbs : false # true, false (default) words_per_minute : 160 @@ -47,14 +117,17 @@ staticman: options: format : "iso8601" # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds" atom_feed: + hide : false # change to true to hide the RSS feed in the footer path : # blank (default) uses feed.xml + # SEO Related google_site_verification : bing_site_verification : alexa_site_verification : yandex_site_verification : + # Social Sharing twitter: username : &twitter @@ -73,50 +146,11 @@ social: # Analytics analytics: - provider : "google-universal" # false (default), "google", "google-universal", "custom" + provider : "false" # false (default), "google", "google-universal", "google-analytics-4", "custom" google: tracking_id : -# Site Author -author: - name : "Your Sidebar Name" - avatar : "profile.png" - bio : "Your biography for the left-hand sidebar" - location : "Location" - employer : - pubmed : "https://www.ncbi.nlm.nih.gov/pubmed/?term=john+snow" - googlescholar : "http://yourfullgooglescholarurl.com" - email : - researchgate : # example: "https://www.researchgate.net/profile/yourprofile" - uri : - bitbucket : - codepen : - dribbble : - flickr : - facebook : - foursquare : - github : "academicpages" - google_plus : - keybase : - instagram : - impactstory : #"https://profiles.impactstory.org/u/xxxx-xxxx-xxxx-xxxx" - lastfm : - linkedin : - orcid : "http://orcid.org/yourorcidurl" - pinterest : - soundcloud : - stackoverflow : # http://stackoverflow.com/users/123456/username - steam : - tumblr : - twitter : "replacethistwitterhandle" - vine : - weibo : - xing : - youtube : - wikipedia : - - # Reading Files include: - .htaccess @@ -127,23 +161,26 @@ exclude: - "*.sublime-workspace" - .asset-cache - .bundle + - .github - .jekyll-assets-cache - .sass-cache - - CHANGELOG - - Capfile - - Gemfile - - Gruntfile.js - - LICENSE - - README - - Rakefile - assets/js/_main.js - assets/js/plugins - assets/js/vendor + - CHANGELOG + - Capfile - config + - Dockerfile + - Gemfile + - Gruntfile.js - gulpfile.js + - LICENSE + - local - log - node_modules - - package.json + - package.json* + - Rakefile + - README - tmp - vendor keep_files: @@ -173,7 +210,7 @@ kramdown: enable_coderay: false -# Collections +# These settings control the types of collections used by the template collections: teaching: output: true @@ -189,7 +226,7 @@ collections: permalink: /:collection/:path/ -# Defaults +# These settings control how pages and collections are included in the site defaults: # _posts - scope: @@ -245,6 +282,7 @@ defaults: author_profile: true share: true + # Sass/SCSS sass: sass_dir: _sass @@ -255,22 +293,25 @@ sass: permalink: /:categories/:title/ # paginate: 5 # amount of posts to show # paginate_path: /page:num/ -timezone: America/Los_Angeles # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones +timezone: Etc/UTC # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones # Plugins plugins: + - jekyll-feed + - jekyll-gist - jekyll-paginate - jekyll-sitemap - - jekyll-gist - - jekyll-feed - jekyll-redirect-from -# mimic GitHub Pages with --safe + - jemoji + +# Mimic GitHub Pages with --safe whitelist: + - jekyll-feed + - jekyll-gist - jekyll-paginate - jekyll-sitemap - - jekyll-gist - - jekyll-feed + - jekyll-redirect-from - jemoji diff --git a/_data/navigation.yml b/_data/navigation.yml index 4997490d2fb..5959f5879b0 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -1,4 +1,9 @@ -# main links links +# The following is the order of the links in the header of the website. +# +# Changing the order here will adjust the order and you can also add additional +# links. Removing a link prevents it from showing in the header, but does not +# prevent it from being included in the site. + main: - title: "Publications" url: /publications/ diff --git a/_data/ui-text.yml b/_data/ui-text.yml index f37f7fa7721..47c476cfbf5 100644 --- a/_data/ui-text.yml +++ b/_data/ui-text.yml @@ -66,27 +66,27 @@ es: &DEFAULT_ES categories_label : "Categorías:" date_label : "Actualizado:" comments_label : "Comentar" - comments_title : + comments_title : "Deja un comentario" more_label : "Ver más" - related_label : "Podrías ver también" + related_label : "Quizás te interese" follow_label : "Seguir:" feed_label : "Feed" - powered_by : "Powered by" + powered_by : "Creado por" website_label : "Sitio web" - email_label : "Email" + email_label : "Correo" recent_posts : "Entradas recientes" - undefined_wpm : "Parametro words_per_minute (Palabras por minuto) no definido en _config.yml" - comment_form_info : - comment_form_comment_label : - comment_form_md_info : - comment_form_name_label : - comment_form_email_label : - comment_form_website_label : - comment_btn_submit : - comment_btn_submitted : - comment_success_msg : - comment_error_msg : - loading_label : + undefined_wpm : "Parámetro words_per_minute (palabras por minuto) no definido en _config.yml" + comment_form_info : "No se publicará tu correo electrónico. Véanse marcados los campos obligatorios" + comment_form_comment_label : "Comentario" + comment_form_md_info : "Markdown es compatible" + comment_form_name_label : "Nombre" + comment_form_email_label : "Correo electrónico" + comment_form_website_label : "Página web (opcional)" + comment_btn_submit : "Enviar comentario" + comment_btn_submitted : "Enviado" + comment_success_msg : "¡Gracias por tu comentario! Aparecerá en la página cuando sea aprobado." + comment_error_msg : "Lo sentimos, ha habido un error con tu solicitud. Por favor, asegúrate de rellenar todos los campos obligatorios e inténtalo de nuevo." + loading_label : "Cargando..." es-ES: <<: *DEFAULT_ES es-CO: @@ -266,5 +266,89 @@ it: &DEFAULT_IT it-IT: <<: *DEFAULT_IT +# Chinese (simplified) +# ----------------- +zh: &DEFAULT_ZH + page : "页面" + pagination_previous : "上一页" + pagination_next : "下一页" + breadcrumb_home_label : "主页" + breadcrumb_separator : "/" + toc_label : "本页内容" + ext_link_label : "直接链接" + less_than : "少于" + minute_read : "分钟阅读时长" + share_on_label : "分享到" + meta_label : + tags_label : "标签：" + categories_label : "分类：" + date_label : "发布时间：" + comments_label : "发表评论" + comments_title : "评论" + more_label : "了解更多" + related_label : "你可能感兴趣的" + follow_label : "关注：" + feed_label : "打赏" + powered_by : "技术支持：" + website_label : "网站" + email_label : "电子邮件" + recent_posts : "最新文章" + undefined_wpm : "_config.yml中未定义words_per_minute参数" + comment_form_info : "您的电子邮件地址不会被公开。（必填项已标注）" + comment_form_comment_label : "评论" + comment_form_md_info : "支持Markdown格式" + comment_form_name_label : "姓名" + comment_form_email_label : "电子邮件地址" + comment_form_website_label : "网站（可选）" + comment_btn_submit : "提交评论" + comment_btn_submitted : "已提交" + comment_success_msg : "感谢您的评论！审核通过后会显示在网站上。" + comment_error_msg : "抱歉，提交时出错。请确保所有必填项已完成，并重试。" + loading_label : "加载中..." +zh-CN: + <<: *DEFAULT_ZH + +# Chinese (traditional) +# ----------------- +zh-HK: &DEFAULT_ZH_HK + page : "頁面" + pagination_previous : "上一頁" + pagination_next : "下一頁" + breadcrumb_home_label : "主頁" + breadcrumb_separator : "/" + toc_label : "本頁內容" + ext_link_label : "直接連結" + less_than : "少於" + minute_read : "分鐘閱讀時長" + share_on_label : "分享到" + meta_label : + tags_label : "標籤：" + categories_label : "分類：" + date_label : "發布時間：" + comments_label : "發表評論" + comments_title : "評論" + more_label : "了解更多" + related_label : "你可能感興趣的" + follow_label : "關注：" + feed_label : "打賞" + powered_by : "技術支持：" + website_label : "網站" + email_label : "電子郵件" + recent_posts : "最新文章" + undefined_wpm : "_config.yml中未定義words_per_minute參數" + comment_form_info : "您的電子郵件地址不會被公開。（必填項已標註）" + comment_form_comment_label : "評論" + comment_form_md_info : "支持Markdown格式" + comment_form_name_label : "姓名" + comment_form_email_label : "電子郵件地址" + comment_form_website_label : "網站（可選）" + comment_btn_submit : "提交評論" + comment_btn_submitted : "已提交" + comment_success_msg : "感謝您的評論！審核通過後會顯示在網站上。" + comment_error_msg : "抱歉，提交時出錯。請確保所有必填項已完成，並重試。" + loading_label : "加載中..." +zh-TW: + <<: *DEFAULT_ZH_HK + # Another locale # -------------- diff --git a/_includes/analytics-providers/google-analytics-4.html b/_includes/analytics-providers/google-analytics-4.html new file mode 100644 index 00000000000..c1ed70c3238 --- /dev/null +++ b/_includes/analytics-providers/google-analytics-4.html @@ -0,0 +1,8 @@ + + diff --git a/_includes/analytics.html b/_includes/analytics.html index 64a3359aad4..8f3dda96622 100644 --- a/_includes/analytics.html +++ b/_includes/analytics.html @@ -5,6 +5,8 @@ {% include /analytics-providers/google.html %} {% when "google-universal" %} {% include /analytics-providers/google-universal.html %} +{% when "google-analytics-4" %} + {% include /analytics-providers/google-analytics-4.html %} {% when "custom" %} {% include /analytics-providers/custom.html %} {% endcase %} diff --git a/_includes/archive-single.html b/_includes/archive-single.html index 25784719eb2..7fa30642e5e 100644 --- a/_includes/archive-single.html +++ b/_includes/archive-single.html @@ -52,12 +52,18 @@

{{ post.excerpt | markdownify | remove: '

' | remove: '

' }} Read more

{% endif %} - {% if post.citation and post.paperurl %} -

Recommended citation: {{ post.citation }} {{ post.paperurl }}

+ {% if post.citation and post.paperurl and post.slidesurl %} +

Recommended citation: {{ post.citation }}
Download Paper | Download Slides

+ {% elsif post.citation and post.paperurl %} +

Recommended citation: {{ post.citation }}
Download Paper

+ {% elsif post.citation and post.slidesurl %} +

Recommended citation: {{ post.citation }}
Download Slides

{% elsif post.citation %} -

Recommended citation: {{ post.citation }}

+

Recommended citation: {{ post.citation }}

{% elsif post.paperurl %} -

Download here

+

Download Paper

+ {% elsif post.slidesurl %} +

Download Slides

{% endif %} diff --git a/_includes/author-profile.html b/_includes/author-profile.html index 55449165574..cab56b976f4 100644 --- a/_includes/author-profile.html +++ b/_includes/author-profile.html @@ -16,108 +16,146 @@

{{ author.name }}

+ {% if author.pronouns %}

{{ author.pronouns }}

{% endif %} {% if author.bio %}

{{ author.bio }}

{% endif %}
diff --git a/_includes/comments.html b/_includes/comments.html index 53bc53981fe..439b45f33d5 100644 --- a/_includes/comments.html +++ b/_includes/comments.html @@ -76,6 +76,8 @@

{{ site.data.ui-text[site.locale].comments_labe {% endif %} {% when "custom" %} +

{{ comments_label }}

+ {% include /comments-providers/scripts.html %} {% endcase %} \ No newline at end of file diff --git a/_includes/footer.html b/_includes/footer.html index 224d9b8908d..468e3540d16 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,24 +1,25 @@ {% include base_path %} +{% if site.author.github or site.author.bitbucket or site.atom_feed.hide != true %}
+{% endif %} -
© {{ site.time | date: '%Y' }} {{ site.name | default: site.title }}. {{ site.data.ui-text[site.locale].powered_by | default: "Powered by" }} Jekyll & AcademicPages, a fork of Minimal Mistakes.
+
+ © {{ site.time | date: '%Y' }} {{ site.name | default: site.title }}, {{ site.data.ui-text[site.locale].powered_by | default: "Powered by" }} Jekyll & AcademicPages, a fork of Minimal Mistakes.
+ Site last updated {{ "now" | date: '%Y-%m-%d' %}} +
diff --git a/_includes/head/custom.html b/_includes/head/custom.html index 2a0b1c21e00..1a0120ebb40 100644 --- a/_includes/head/custom.html +++ b/_includes/head/custom.html @@ -24,15 +24,9 @@ - - - + + + + diff --git a/_includes/scripts.html b/_includes/scripts.html index 138d271e28e..a1746033930 100644 --- a/_includes/scripts.html +++ b/_includes/scripts.html @@ -1,4 +1,3 @@ {% include analytics.html %} -{% include /comments-providers/scripts.html %} diff --git a/_includes/seo.html b/_includes/seo.html index a43115b9a3f..2885af2ad70 100644 --- a/_includes/seo.html +++ b/_includes/seo.html @@ -49,7 +49,7 @@ {% endif %} {% if page.excerpt %} - + {% endif %} {% if site.twitter.username %} diff --git a/_layouts/single.html b/_layouts/single.html index 6290cd24e60..3cd3b1d2daa 100644 --- a/_layouts/single.html +++ b/_layouts/single.html @@ -40,20 +40,25 @@

Published in {{ page.venue }}, {{ page.date | default: "1900-01-01" | date: "%Y" }}

{% elsif page.date %}

{{ site.data.ui-text[site.locale].date_label | default: "Published:" }}

- {% endif %} - - - {% if page.citation and page.paperurl %} -

Recommended citation: {{ page.citation }} {{ page.paperurl }}

- {% elsif page.citation %} -

Recommended citation: {{ page.citation }}

- {% endif %} - + {% endif %} {% endunless %}
{{ content }} + + {% if page.citation and page.paperurl and page.slidesurl %} +

Recommended citation: {{ page.citation }}
Download Paper | Download Slides

+ {% elsif page.citation and page.paperurl %} +

Recommended citation: {{ page.citation }}
Download Paper

+ {% elsif page.citation and page.slidesurl %} +

Recommended citation: {{ page.citation }}
Download Slides

+ {% elsif page.citation %} +

Recommended citation: {{ page.citation }}

+ {% elsif page.slidesurl %} +

Download Slides

+ {% endif %} + {% if page.link %}
{{ site.data.ui-text[site.locale].ext_link_label | default: "Direct Link" }}
{% endif %}
diff --git a/_pages/404.md b/_pages/404.md index 9d0f8606612..a2c7b222b82 100644 --- a/_pages/404.md +++ b/_pages/404.md @@ -1,16 +1,7 @@ --- title: "Page Not Found" -excerpt: "Page not found. Your pixels are in another canvas." sitemap: false permalink: /404.html --- -Sorry, but the page you were trying to view does not exist --- perhaps you can try searching for it below. - - - +Sorry, but the page you were trying to view does not exist. diff --git a/_pages/about.md b/_pages/about.md index e7185db641c..387e2f31cd7 100644 --- a/_pages/about.md +++ b/_pages/about.md @@ -1,25 +1,24 @@ --- permalink: / -title: "academicpages is a ready-to-fork GitHub Pages template for academic personal websites" -excerpt: "About me" +title: "Academic Pages is a ready-to-fork GitHub Pages template for academic personal websites" author_profile: true redirect_from: - /about/ - /about.html --- -This is the front page of a website that is powered by the [academicpages template](https://github.com/academicpages/academicpages.github.io) and hosted on GitHub pages. [GitHub pages](https://pages.github.com) is a free service in which websites are built and hosted from code and data stored in a GitHub repository, automatically updating when a new commit is made to the respository. This template was forked from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/) created by Michael Rose, and then extended to support the kinds of content that academics have: publications, talks, teaching, a portfolio, blog posts, and a dynamically-generated CV. You can fork [this repository](https://github.com/academicpages/academicpages.github.io) right now, modify the configuration and markdown files, add your own PDFs and other content, and have your own site for free, with no ads! An older version of this template powers my own personal website at [stuartgeiger.com](http://stuartgeiger.com), which uses [this Github repository](https://github.com/staeiou/staeiou.github.io). +This is the front page of a website that is powered by the [Academic Pages template](https://github.com/academicpages/academicpages.github.io) and hosted on GitHub pages. [GitHub pages](https://pages.github.com) is a free service in which websites are built and hosted from code and data stored in a GitHub repository, automatically updating when a new commit is made to the repository. This template was forked from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/) created by Michael Rose, and then extended to support the kinds of content that academics have: publications, talks, teaching, a portfolio, blog posts, and a dynamically-generated CV. You can fork [this template](https://github.com/academicpages/academicpages.github.io) right now, modify the configuration and markdown files, add your own PDFs and other content, and have your own site for free, with no ads! A data-driven personal website ====== -Like many other Jekyll-based GitHub Pages templates, academicpages makes you separate the website's content from its form. The content & metadata of your website are in structured markdown files, while various other files constitute the theme, specifying how to transform that content & metadata into HTML pages. You keep these various markdown (.md), YAML (.yml), HTML, and CSS files in a public GitHub repository. Each time you commit and push an update to the repository, the [GitHub pages](https://pages.github.com/) service creates static HTML pages based on these files, which are hosted on GitHub's servers free of charge. +Like many other Jekyll-based GitHub Pages templates, Academic Pages makes you separate the website's content from its form. The content & metadata of your website are in structured markdown files, while various other files constitute the theme, specifying how to transform that content & metadata into HTML pages. You keep these various markdown (.md), YAML (.yml), HTML, and CSS files in a public GitHub repository. Each time you commit and push an update to the repository, the [GitHub pages](https://pages.github.com/) service creates static HTML pages based on these files, which are hosted on GitHub's servers free of charge. -Many of the features of dynamic content management systems (like Wordpress) can be achieved in this fashion, using a fraction of the computational resources and with far less vulnerability to hacking and DDoSing. You can also modify the theme to your heart's content without touching the content of your site. If you get to a point where you've broken something in Jekyll/HTML/CSS beyond repair, your markdown files describing your talks, publications, etc. are safe. You can rollback the changes or even delete the repository and start over -- just be sure to save the markdown files! Finally, you can also write scripts that process the structured data on the site, such as [this one](https://github.com/academicpages/academicpages.github.io/blob/master/talkmap.ipynb) that analyzes metadata in pages about talks to display [a map of every location you've given a talk](https://academicpages.github.io/talkmap.html). +Many of the features of dynamic content management systems (like Wordpress) can be achieved in this fashion, using a fraction of the computational resources and with far less vulnerability to hacking and DDoSing. You can also modify the theme to your heart's content without touching the content of your site. If you get to a point where you've broken something in Jekyll/HTML/CSS beyond repair, your markdown files describing your talks, publications, etc. are safe. You can rollback the changes or even delete the repository and start over - just be sure to save the markdown files! Finally, you can also write scripts that process the structured data on the site, such as [this one](https://github.com/academicpages/academicpages.github.io/blob/master/talkmap.ipynb) that analyzes metadata in pages about talks to display [a map of every location you've given a talk](https://academicpages.github.io/talkmap.html). Getting started ====== 1. Register a GitHub account if you don't have one and confirm your e-mail (required!) -1. Fork [this repository](https://github.com/academicpages/academicpages.github.io) by clicking the "fork" button in the top right. +1. Fork [this template](https://github.com/academicpages/academicpages.github.io) by clicking the "Use this template" button in the top right. 1. Go to the repository's settings (rightmost item in the tabs that start with "Code", should be below "Unwatch"). Rename the repository "[your GitHub username].github.io", which will also be your website's URL. 1. Set site-wide configuration and create content & metadata (see below -- also see [this set of diffs](http://archive.is/3TPas) showing what files were changed to set up [an example site](https://getorg-testacct.github.io) for a user with the username "getorg-testacct") 1. 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. @@ -35,8 +34,8 @@ For site content, there is one markdown file for each type of content, which are **Markdown generator** -I have also created [a set of Jupyter notebooks](https://github.com/academicpages/academicpages.github.io/tree/master/markdown_generator -) that converts a CSV containing structured data about talks or presentations into individual markdown files that will be properly formatted for the academicpages template. The sample CSVs in that directory are the ones I used to create my own personal website at stuartgeiger.com. My usual workflow is that I keep a spreadsheet of my publications and talks, then run the code in these notebooks to generate the markdown files, then commit and push them to the GitHub repository. +The repository includes [a set of Jupyter notebooks](https://github.com/academicpages/academicpages.github.io/tree/master/markdown_generator +) that converts a CSV containing structured data about talks or presentations into individual markdown files that will be properly formatted for the Academic Pages template. The sample CSVs in that directory are the ones I used to create my own personal website at stuartgeiger.com. My usual workflow is that I keep a spreadsheet of my publications and talks, then run the code in these notebooks to generate the markdown files, then commit and push them to the GitHub repository. How to edit your site's GitHub repository ------ @@ -47,4 +46,4 @@ Example: editing a markdown file for a talk For more info ------ -More info about configuring academicpages can be found in [the guide](https://academicpages.github.io/markdown/). The [guides for the Minimal Mistakes theme](https://mmistakes.github.io/minimal-mistakes/docs/configuration/) (which this theme was forked from) might also be helpful. +More info about configuring Academic Pages can be found in [the guide](https://academicpages.github.io/markdown/), the [growing wiki](https://github.com/academicpages/academicpages.github.io/wiki), and you can always [ask a question on GitHub](https://github.com/academicpages/academicpages.github.io/discussions). The [guides for the Minimal Mistakes theme](https://mmistakes.github.io/minimal-mistakes/docs/configuration/) (which this theme was forked from) might also be helpful. diff --git a/_pages/cv.md b/_pages/cv.md index e0e835444ed..a3ff17ba691 100644 --- a/_pages/cv.md +++ b/_pages/cv.md @@ -11,21 +11,26 @@ redirect_from: Education ====== -* B.S. in GitHub, GitHub University, 2012 -* M.S. in Jekyll, GitHub University, 2014 * Ph.D in Version Control Theory, GitHub University, 2018 (expected) +* M.S. in Jekyll, GitHub University, 2014 +* B.S. in GitHub, GitHub University, 2012 Work experience ====== -* Summer 2015: Research Assistant +* Spring 2024: Academic Pages Collaborator * Github University - * Duties included: Tagging issues - * Supervisor: Professor Git + * Duties includes: Updates and improvements to template + * Supervisor: The Users * Fall 2015: Research Assistant * Github University * Duties included: Merging pull requests * Supervisor: Professor Hub + +* Summer 2015: Research Assistant + * Github University + * Duties included: Tagging issues + * Supervisor: Professor Git Skills ====== @@ -38,19 +43,19 @@ Skills Publications ====== -