SRC Web Team Tools & Tech

# Welcome to Strategic Relations

# Introduction

This site is dedicated to documenting the tools and technologies that we use in SRC. The web team is responsible for making web services that help campus departments and organizations. Our main project is Web Express, a site builder for CU organizations. Please don't hesitate to add and contribute to these docs since they're a valuable source of information for everyone on the team.

# What to Add

You can add anything to these docs as long as its a relavent technology to SRC. Each heading on the sidebar has multiple sub topics. You can add new subtopics or edit what currently exists. These docs are meant to provide a high level overview for a topic, resources for further learning, or tutorials for usage/installation.

# How to Edit

The content is generated with markdown. You can edit the files locally, or through the GitHub Web UI.

# Local Development

  1. First make sure that node and npm are installed.
  2. Clone this repo
git clone https://github.com/CuBoulder/src-tools-tech.git
  1. Install the project dependencies
npm install
  1. Start the Development Server
npm run docs:dev
  1. Adding a new Page:
// Add a file to the docs directory
touch <pagename>.md

// To add a link to the sidebar, add the pagename to the sidebar array in the config.js file
sidebar: [
    ...,
    '/pagename'
]
  • The name of the link in the sidebar will be the Heading 1 (#) name of the markdown file.
  • Any sub-links on the sidebar are the Heading 2 (##) names.
  • A good way to write markdown is to use Stack Edit
  1. Commit and Push your changes. Netlify will automatically rebuild and deploy the site.

# Edit with the GitHub Web UI

  1. Make changes in the markdown files online. You can access the direct file by clicking on the 'Edit this Page!' link at the bottom of each page of the site.
  2. Add a commit message.

Hypertext Markup Language (HTML) →