This is based on a subset the template we use for projects in the lab. We've omitted experiments, paper, and protocols.
- code
- data
- images
- json
- meetings
- outline.md
- slides
- website
Source code lives here!
Data lives here. Whenever possible, structure as json (your code should read and write json), or in its original raw format (e.g. tiff).
What's happened recently? What's our plan?
This is bullet-point outline of the project. It can be considered a rough outline of the paper, but of course things can change before things get to the manuscript-writing phase, so this document should be the primary home of all the project ideas and questions until it's clear that it's time to write the paper.
Summary slides of the project that could be used for introducting the project, teaching, etc.
Every project should ultimately be able to serve its own website. The site (e.g. jekyll, etc) should live here.
If you're working on a blog post and it isnt finished you can name it 'something-title.md'; and commit it to the repository. When it's ready you can 'pubish' it by prepending the date to the name. Alternatively you can add: published: true to that file's yaml frontmatter.
The /assets/css/main.scss is really the important file here. It just imports a list of .scss files - jekyll knows where those are located (/assets/_sass), we tell it in the _config.yml file in the root dir.
Jekyll parses all the files imported in the '/assets/css/main.scss' file, and generates it into one, single, compressed file ucalled /_site/assets/css/main.css.
The grid we use is Bourbon's Neat. It's a semantic grid, so we style elements directly, not fill our html up with classes like 'article class="etc"'. The documentation is pretty easy.
The grid is only invoked in two places: assets/_sass/layout.scss and /assets/_sass/grid-settings.scss
We don't mention the grid anywhere else, not in styles or typography or anywhere else.
We use Typeplate to set some basicly proper typographical proportions - not font choices but their behavior, relationship stuff. This is very subtle stuff, and shouldnt be touched. They're loaded in /assets/_sass/typelate-scss/*