Skip to content

Latest commit

 

History

History
82 lines (46 loc) · 3.77 KB

README.md

File metadata and controls

82 lines (46 loc) · 3.77 KB

CDS-Website

Maintaining

Nearly all content (words and images) are controlled by a set of json files located in assets/json/. To update the site, simply edit the json and merge it into the main branch. Most images are simply placed into the assets/img/ folder, and are included via its name in a json file.

The team pages are algo.json, crossteam.json, de.json, edu.json, insights.json, and intsys.json accordingly. teams.json corresponds to the team overview page. home.json is for the home page. leads.json and members.json refer to the people page. recruitment.json is for the recruitment page.

In order to update the members.json file, update people.md then run $ python members2json.py which will write the relevant information to the json file. The order of people in the md file corresponds to the website.

To change a photo, change the name of the file referenced in the corresponding json file. Make sure the image is located in the assets/img/ folder unless it's a headshot, in which case it belongs in assets/img/headshots/.

Build Setup

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

For detailed explanation on how things work, check out the documentation.

Special Directories

You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.

assets

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.

More information about the usage of this directory in the documentation.

components

The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.

More information about the usage of this directory in the documentation.

layouts

Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.

More information about the usage of this directory in the documentation.

pages

This directory contains your application views and routes. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically.

More information about the usage of this directory in the documentation.

plugins

The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use Vue.use(), you should create a file in plugins/ and add its path to plugins in nuxt.config.js.

More information about the usage of this directory in the documentation.

static

This directory contains your static files. Each file inside this directory is mapped to /.

Example: /static/robots.txt is mapped as /robots.txt.

More information about the usage of this directory in the documentation.

store

This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.

More information about the usage of this directory in the documentation.