/fa22tapeout-course-dev

Primary LanguageHTMLBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

EE290C Spring 2023 Chipyard Lab Decv

EE290C Spring 2022 Course Site


Editing

Editing the course site is performed through git. Each git-push is published by GitHub Pages after a short HTML build process. (Usually one to a few minutes.)

Most content is written in Markdown and compiled into HTML on GitHub's servers. Examples of most common elements are included in the existing home page, as well as the help-excerpt below.

The course home page is index.md. Thus far essentially all content is in the home-page, save for attached files such as PDFs and images.

Attachments, Files & Assets

The GitHub-stack seems to prefer any such files be kept in the assets/ directory. Example PDF attachment: demo.pdf.

Styling

Our general intent is to perform as little custom style-izing as we can. The site template is courtesy the Pages Cayman theme. A few tweaks are applied, particularly to drop a few tropical colors and replace them with some more Berkeley-ish ones.

If you do really want to much with the site style, it's largely done with the SASS in assets/css.

Running Locally

GitHub provides a terrific guide on how to run local preview-versions of our site before publishing them. This will generally require installing some Ruby packages, and if necessary Ruby itself.

Non-Published Content

Drafts, planning documents, and any other material not intended for site-publication are generally placed in the _private directory. Anything in files and directories beginning with _, ., or a few other special characters will be left out of the published site.

Note: this README file is among the published content! (Although it's not rendered and styled as HTML.)


(A GitHub Pages Help Excerpt)

You can use the editor on GitHub to maintain and preview the content for your website in Markdown files.

Whenever you commit to this repository, GitHub Pages will run Jekyll to rebuild the pages in your site, from the content in your Markdown files.

Markdown

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for

Syntax highlighted code block

# Header 1
## Header 2
### Header 3

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)

For more details see GitHub Flavored Markdown.

Jekyll Themes

Your Pages site will use the layout and styles from the Jekyll theme you have selected in your repository settings. The name of this theme is saved in the Jekyll _config.yml configuration file.

Support or Contact

Having trouble with Pages? Check out our documentation or contact support and we’ll help you sort it out.