https://github.com/cboucher01/dssf-blog
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: cboucher01
- License: mit
- Language: SCSS
- Default Branch: master
- Size: 30.9 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 4
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
DSSF 2022 Blog Site
Note: This repo may be using an old version of the Webrick gem that has critical security vulnerabilities. This site is no longer being updated or maintained.
Site function
The Digital Scholarship Summer Fellow Blog was a beginner project for the fellows to develop our web-development skills while creating a site to host our blog posts and information about us and the digital web design toolkit that we are currently building. During the coding process, we came across multiple challenges, including aligning our navbar, coordinating work on the site with multiple people using GitHub, organizing our workflow requests, and finally, deploying the site on GitHub. In the future, we are considering adding onto the site to make it a library depot for our learning resources for our future project, the digital web design toolkit.
Which kinds of code did we use?
- HTML
- SCSS
- JavaScript/Bootstrap
- Jekyll/Ruby
Working with Minima
This site was created by editing Minima, Jekyll's first and default theme. As the default theme, Minima was a useful resource for developing the DSSF 2022 blog.
Though there were various aesthetic changes made to the layout, navigation bar, background, post box, titles, headers, and more, portions of our site still rely on Minima to operate.
You can compare our code and find out more about Minima here.
How-to install and run
The best way to run this project is to click on the website link here.
If you would like to make changes or add edits to the code, you can do that by forking this repository and adding it to your personal repositories on GitHub. From there, you can make changes directly on GitHub or download onto your computer and open with the VS Code application or your preferred text editor.
Site Features
- Navbar
- Templates/Skins
- Site Background
Navbar
- To view the code used for the navigation bar: locate the folder labeled "_ includes" then open the file labeled "header.html". Code for the navigation bar begins at <nav class=...
- This navigation bar was created by following the Bootstrap 4.0 Documentation found here. While Minima has responsive elements within the theme, for the sake of our project goals this summer we wanted to learn more about Bootstrap by integrating this navigation bar ourselves.
Within the folder labeled "sass\minima" in the file "layout.scss" we adjusted the padding and alignment of the navigation bar under the "site.nav" section and added further styling. ``` .site-nav { position: absolute; top: $spacing-unit / 2; right: $spacing-unit / 2; background-color: $background-color-2; border: 1px solid $border-color-01; padding: 10px; border-radius: 5px; text-align: right; flex-wrap: nowrap;
} ```
You can load the Minima sample site to view the differences between the default navigation bar and ours in appearance, or open the page source (right click on the page and select view page source from the dropdown) to compare the code in your browser.
If you are building the Bootstrap 4.0 Navbar into your Jekyll site through the default Minima theme like we did and notice an alignment error when minimizing the desktop window (or on mobile) where the opened menu is not inline with the Site Title, we fixed this problem by adding "flex-wrap: nowrap;" to the "_layout.scss" file under the "site.nav" section.
Customizing Templates: Creating Our Lemon-Lime Skin
In order to change the color palette and overall theme of the website, we used a feature called “skins.” Skins allow you to create an entire theme that, with just editing a line of code, you can change your website's fonts, font colors, background, opacity, and really anything else you'd like.
According to Minima, you should start out with at least the following code in your assets/css/style.scss file
```
@import "minima/skins/{{ site.minima.skin | default: 'classic' }}"; @import "minima/initialize"; ```
To design our signature “lemon-lime” theme used on our site, we copied the code of the classic minima skin from here, pasted it all into a new file called lemon-lime.scss , and then changed code and added new code, like $background-color-1: #82a573 !default; and $link-hover-color: $text-color-1 !default; to create the new skin.
- just a note, the dollar sign $ refers to a new variable we created such as $background-color-1 which you can assign to other variable in your code and it will copy and retain the same information that you originally assigned to that variable. For example, the $link-hover-color is a new variable but we are assigning the same colors and setting as $text-color-1 which are just listed as #000000, or black, in hex color values.
.
├── _sass/minima
└── skins
└── lemon-lime.scss
Then, in order to view our changes on our website, we updated the assets/css/style.scss file to include the default theme 'lemon-lime' instead of 'classic,' which finalized our changes.
```
Only the main Sass file needs front matter (the dashes are enough)
@import "minima/skins/{{ site.minima.skin | default: 'lemon-lime' }}", "minima/initialize"; ```
Site Background
The gradient: To create the color gradient we edited the body section of the base.scss file within sass/minima as follows
body { font: $base-font-weight #{$base-font-size}/#{$base-line-height} $base-font-family; color: $text-color; /* background-color: $background-color; */ background-image: linear-gradient($background-color-1, $background-color-2);The background image: To add the background image, we first took pictures of the creatures and traced them using ClipStudio Paint. We then arranged them on a transparent png background so that they would repeat as shown on the blog when "tiled". Tiling is when a rendered image repeats to fill a display space. Jekyll automatically tiles background images. The pattern we made is called creature-tile.png and can be found in the assets folder under the creature-icons sub-folder. To implement this we added the following section to the base.scss file found in the sass/minima folder:
.creature-background { background-image: url(/dssf-blog/assets/creature-icons/creature-tile.png); }Then a div class called "creature-background" was added to each page.
Useful resources:
Owner
- Name: Cameron Boucher
- Login: cboucher01
- Kind: user
- Repositories: 1
- Profile: https://github.com/cboucher01
GitHub Events
Total
Last Year
Dependencies
- github-pages >= 0 development
- jekyll-feed ~> 0.12 development
- http_parser.rb ~> 0.6.0
- jekyll-archives >= 0
- minima ~> 2.5
- tzinfo ~> 1.2
- tzinfo-data >= 0
- wdm ~> 0.1.1
- webrick ~> 1.7