{{ page.title }}
+ {% endunless %} +{{ page.excerpt }}
+ + {% include datasets_filters.html %} -{{ content }} + {% assign entries_layout = page.entries_layout | default: 'list' %} +diff --git a/README.md b/README.md index 4c54ceb..92275f1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Built using [Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes) and [Jekyll](https://jekyllrb.com). -## Documentation for BLASTNet maintainers and contributors +# Documentation for BLASTNet maintainers and contributors This repository contains all the code for the blastnet.github.io website. Most of the Minimal Mistakes features and layouts are not used (and will likely never be used) and so they have been removed for a smoother and lighter build experience. Yet, some new features like the data counters have also been added. Therefore, please read this documentation carefully. @@ -76,7 +76,7 @@ gem install jekyll bundler First, clone the repository: ```bash -git clone https://github.com/ihmegroup/website +git clone https://github.com/blastnet/blastnet.github.io ``` You can also fork the repository and clone that, if you prefer. @@ -101,22 +101,13 @@ There are some options/flags that this command takes, the most pertinent of whic ### Important -Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. The url should be `fxlab.stanford.edu` and baseurl blank, do not delete it. +Make sure to not touch anything in the `_config.yml` file unless you know what you are doing. This file is used by Jekyll to build everything, so making a mistake here will likely break the entire website. --- ## Pushing to production -**Never push to production on Fridays!** (jk) - -Once the site has been built, all the relevant files will be in the `_site` folder, ready to be uploaded to the Stanford domain. I also recommend cleaning up the CSS to remove unused classes, which speeds up loading time and reduces filesize, this can be done by running - -```bash -purgecss -c purgecss.config.js -``` -which will replace the CSS files in the `_site/assets/css/` folder with the purged css files. - -If using Github pages, simply run `bundle exec jekyll clean` to remove the build files, then commit changes and push to the `main` branch. I do recommend making major code-breaking or other stylistic changes on a development branch or fork, before making a pull request to the main branch. +The site is built and hosted on Github pages, so it suffices to simply run `bundle exec jekyll clean` to remove the build files, then commit changes and push to the `master` branch. Please try to make major code-breaking or other stylistic changes on a development branch or fork, before making a pull request to the master branch. --- @@ -154,9 +145,16 @@ description: Rayleigh-Bénard Convection DNS header: teaser: /assets/img/ico_roshan2024.png image: /assets/img/roshan2024.png +categories: +- nonreacting +- channel +- pipe +- turbulent +- threeD +- numerical --- ``` -For each new dataset, count the number of cases and update the excerpt. Then, update the title and description as per normal. Header teaser corresponds to the icon displayed in the gallery (this keyword needs to be set or the gallery will not display correctly) and header image corresponds to the banner for the specific dataset; either set the keyword or include the banner as an image on the page using ``. Additionally, for banner images that have a square-ish or vertical aspect ratio, it is possible to put the banner image in the sidebar like: +For each new dataset, count the number of cases and update the excerpt. Add in relevant filter categories under the `categories` keyword as shown above. Then, update the title and description as per normal. Header teaser corresponds to the icon displayed in the gallery (this keyword needs to be set or the gallery will not display correctly) and header image corresponds to the banner for the specific dataset; either set the keyword or include the banner as an image on the page using, for example, ``. Additionally, for banner images that have a square-ish or vertical aspect ratio, it is possible to put the banner image in the sidebar like: ```html
{{ page.excerpt }}
+{% if page.url != "/" and site.breadcrumbs %} + {% unless paginator %} + {% include breadcrumbs.html %} + {% endunless %} +{% endif %} -{% include datasets_filters.html %} +{{ page.excerpt }}
+ + {% include datasets_filters.html %} -{{ content }} + {% assign entries_layout = page.entries_layout | default: 'list' %} +