Giter VIP home page Giter VIP logo

cmu-313.github.io's Introduction

17-313 Course Website

Quick Start

To run the built-in development server:

  1. Create and activate a Python virtual environment

  2. Install requirements

pip install -r requirements.txt
  1. Start local development server
mkdocs serve

You can then find the website running on http://localhost:8000/

For detailed installation instructions, configuration options, and a demo, visit squidfunk.github.io/mkdocs-material

Pre-Semester Setup

  1. Run the following to build the static site:
mkdocs build
  1. Rename the static site folder to its semester-name (i.e. F22). Delete the _old folder within this and move the the folder into the docs/_old directory

  2. Add a link to the old semester in docs/index.md. Test that the old site is still accessible

  3. Within the docs/_data directory, set up information for course links, new staff members, and the semester's schedule. A generate_dates.py script is provided to auto-populate the schedule.yaml file with the expected format - this can be replaced with a csv parsing script later on

  4. Replace the Class Calendar iframe within docs/index.md

  5. Toggle which sites can be navigated to in the mkdocs.yml file under the nav section

cmu-313.github.io's People

Contributors

kevinlin1 avatar anudaweerasinghe avatar victorhuangwq avatar actions-user avatar michaelhilton avatar rohanpadhye avatar angelaz1 avatar tlee0818 avatar abegel avatar antarapal235 avatar namdy0429 avatar christimperley avatar mahimapannala avatar victoralfonzo avatar wodeni avatar dependabot[bot] avatar maggiehua01 avatar alexisaxon avatar sophiajwitt avatar ykharitonova avatar addcninblue avatar ebot101 avatar mzhou08 avatar akindofyoga avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.