Documentation for CSCI 235: Procedural Programming at Charleston Southern University

Deployed CSCI 235 Site

---

This project is a website to host resources for this course. It uses VitePress to generate a website from markdown files. As a result, the website is optimized by Vite.

Setup

1. Install Node which comes with npm (the Node Package Manager).
2. Use npm to install YARN.
   npm install --global yarn
3. Install dependencies.
   yarn install

Development

To edit the content of the lecture notes, modify the markdown files in docs/notes.

To update the sidebar navigation for the lecture notes, modify sidebarNotes() in docs/.vitepress/config.js.

Local Server

Serve the site in the local server using the following command.

yarn docs:dev

VitePress will start a hot-reloading development server at http://localhost:5173.

Deployment

To test the production build before pushing, do the following:

• You may run this command to build the docs:

  $ yarn docs:build

  The output directory is docs/.vitepress/dist.

• Once you've built the docs, you can test them locally by running:

  $ yarn docs:preview

  The preview command will boot up a local static web server that will serve the files from .vitepress/dist at http://localhost:4173. It's an easy way to check if the production build looks fine in your local environment.

The GitHub workflow will automatically deploy the website when the master branch is updated. The website build is in the gh-pages branch.

Visit the deployed site at https://csu-cs.github.io/csci-235/.