Skip to content
Branch: gh-pages
Go to file
Code

README.md

layout title
default
README

Hey HTML Outputters

Here's how this works:


File structure

  1. Make a folder for your project, essay, or interview. You can use one of the folders called SAMPLE as a guide.

  2. Folder naming conventions: interview-LAST NAME OF INTERVIEWEE-LAST NAME OF INTERVIEWER project-YOUR LAST NAME-ONE WORD PROJECT TITLE essay-AUTHOR LAST NAME

  3. Create either an index.html file (for stuff you've designed yourself) or index.md file (to use our default styles, great for essays/interviews).

  4. 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.'

  5. 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

  1. Commit and push your changes

  2. Go to risd-gd.github.io/htmloutput/


If you have Jekyll installed locally

  1. 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 -w means 'watch.' That means every time you make a change to a file, jekyll will run serve and generate a site again. Press Ctrl-C to cancel watching, or just close the terminal window. The --baseurl '' will set the baseurl to nothing, so you can view it locally.

  2. Visit localhost:4000


To install jekyll locally

  1. Run gem install jekyll. If you get an error, try sudo gem install jekyll and enter your password if prompted.

  2. Run gem install kramdown. If you get an error, try sudo gem install kramdown and enter your password if prompted.

About

No description, website, or topics provided.

Resources

Releases

No releases published
You can’t perform that action at this time.