https://github.com/tchajed/sys-verif-fa24

Course website for Systems Verification Fall 2024
https://github.com/tchajed/sys-verif-fa24

verification web

Last synced: about 1 year ago
JSON representation

Course website for Systems Verification Fall 2024

• Host: GitHub
• URL: https://github.com/tchajed/sys-verif-fa24
• Owner: tchajed
• License: other
• Created: 2024-07-23T19:05:17.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T03:19:09.000Z (over 1 year ago)
• Last Synced: 2024-10-30T03:58:20.884Z (over 1 year ago)
• Topics: verification, web
• Language: Shell
• Homepage: https://tchajed.github.io/sys-verif-fa24/
• Size: 950 KB
• Stars: 0
• Watchers: 1
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Systems verification Fall 2024 course website

[![deploy](https://github.com/tchajed/sys-verif-fa24/actions/workflows/deploy.yml/badge.svg)](https://github.com/tchajed/sys-verif-fa24/actions/workflows/deploy.yml) [![website](https://img.shields.io/badge/website-blue?logo=web)](https://tchajed.github.io/sys-verif-fa24/)

[![CC BY-NC 4.0][cc-by-nc-shield]][cc-by-nc]

[cc-by-nc]: https://creativecommons.org/licenses/by-nc/4.0/

[cc-by-nc-shield]: https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg

## Developing

You'll need Node.js and pnpm. You can probably use `corepack enable pnpm` to install pnpm (corepack is now packaged with node), but follow the [corepack](https://pnpm.io/installation#using-corepack) instructions if that doesn't work.

Install the dependencies: `pnpm install`.

Run a dev server to preview changes: `pnpm dev`. The dev server auto-updates and hot-reloads page content, but not structure. Restart it if you make structural changes that affect the sidebar (e.g., add new files), or start it with `pnpm dev --debug` to do a more expensive reload on every change.

Auto-format code (with [prettier](https://prettier.io/)): `pnpm fmt`.

Build static site: `pnpm build`.

## Contributing

Make sure to preview your change with `pnpm dev`: confirm that it compiles, and if any LaTeX is involved, make sure the output doesn't render with red errors.

Run `pnpm fmt`.

You can use the provided git pre-commit hook (in `.git-hooks/`) to automatically format your code (you will need to run `pnpm install` first). Set it up with `git config core.hooksPath .git-hooks/`.

## Tech stack

- pnpm for package management

- [VuePress](https://vuepress.vuejs.org/)

  - Using the [VuePress Hope theme](https://theme-hope.vuejs.press/) (rather than the default)

  - Pretty much the whole setup is in [config.ts](docs/.vuepress/config.ts). YAML frontmatter in individual pages takes care of some aspects.

- Build and deploy via [GitHub Pages workflow](./.github/workflows/deploy.yml)