Hey HTML Outputters
Here's how this works:
Make a folder for your project, essay, or interview. You can use one of the folders called
SAMPLEas a guide.
Folder naming conventions: interview-LAST NAME OF INTERVIEWEE-LAST NAME OF INTERVIEWER project-YOUR LAST NAME-ONE WORD PROJECT TITLE essay-AUTHOR LAST NAME
Create either an
index.htmlfile (for stuff you've designed yourself) or
index.mdfile (to use our default styles, great for essays/interviews).
Put in the appropriate information (title, author etc) at the top in YAML format. Look at the samples to see an example. The project won't show up yet unless it has a category of 'project,' 'interview,' or 'essay.'
Put all assets (images, code, etc) in that folder. TBD: Formatting of more complex or multi-page html
Viewing the site
If you don't want to install Jekyll or deal with the terminal
Commit and push your changes
If you have Jekyll installed locally
Navigate to the htmloutput folder in the terminal and run
jekyll serve -w --baseurl ''.
Note that those are two regular straight quotes despite appearing like smart curly quotes in Anther's typeface. The
-wmeans 'watch.' That means every time you make a change to a file, jekyll will run
serveand generate a site again. Press
Ctrl-Cto cancel watching, or just close the terminal window. The
--baseurl ''will set the baseurl to nothing, so you can view it locally.
To install jekyll locally
gem install jekyll. If you get an error, try
sudo gem install jekylland enter your password if prompted.
gem install kramdown. If you get an error, try
sudo gem install kramdownand enter your password if prompted.