Below you will find building and deployment instructions as well as documentation for plugins and packages that this website depends on.
Our Netlify build is live at https://kwuiux.netlify.app
Note: This site will not build on GitHub pages. It can be optimized to do so, however the "jekyll-scholar" plugin does not work on GitHub Pages, so we opted for deploying on Netlify.
Start by cloning this repository followed by cd jekyll-tailwind
.
Tailwind and our other dev packages need to be built prior to Jekyll, as it needs the manifest.yml
file to link to the properly built CSS.
npm install
npm run dev
npm run prod
npm run watch
bundle install
(if you don't have bundler installed, you may need to run gem install bundler
)bundle update
.bundle exec jekyll serve
, or build using bundle exec jekyll build
_pages
directory. permalink: /page_name
is required on all pages.We are using Netlify to deploy the site. Committing and pushing your changes should be all that is needed to deploy.
If you should need to set this up again, refer to https://www.netlify.com/blog/2020/04/02/a-step-by-step-guide-jekyll-4.0-on-netlify/#connecting-to-netlify
We are using Google's Material Icons to handle all iconography on the website. Add something like <span class="material-icons">face</i>
to use an icon.
This website utilizes TailwindCSS as a CSS framework. The benefit is that it gives you access to the full palette of CSS attributes as clases without writing any CSS.
We've extended our configuration of Tailwind CSS in the following ways:
bg-primary-500
or text-accent-700
text-2xs
and text-3xs
max-w-2xs
or min-w-3xs
text-shadow
classestext-shadow-2xl
for a larger shadow.We've also added NON-Tailwind helper classes to improve the overall Tailwind experience.
.content
class to a wrapper of the content for the purpose of adding styles to <ul>
's, <ol>
's and <p>
's (since Tailwind strips those bare).<main class="content">
will not have those styles.button
on any <a>
is-sm
- Small buttonis-xs
- Extra small buttonis-shadowed
- Adds drop shadow to buttonis-primary
- Button will use the primary color set in the Tailwind configis-secondary
- Button will use the secondary color set in the Tailwind configis-accent
- Button will use the accent color set in the Tailwind configis-outline
- Will make an outlined button