Welcome to HW Lab NITC's Github

This site is built using Vitepress

To run this on your system follow the following steps:

1. Clone and open this repository locally

git clone https://github.com/hwlabnitc/hwlabnitc.github.io.git
cd hwlabnitc.github.io

2. Make sure you have node and npm installed

node --version
npm --version

If not, install it using the appropriate installer from Node.js and npm.

3. Install npm Packages and dependencies:

npm i

4. Build the docs

npm run docs:build

5. Run it locally on your system

npm run docs:dev

Note: The Configuration of the navbar, sidebar, title social links, sidebar etc are present in docs/.vitepress/config.mjs

Note: The markdown files are present in docs

The deploy.yml file is used for deploying the site on github pages

package.json contains the scripts for building and running the site and also the homepage of the site

The site is deployed on HW Lab NITC

Folder Structure

In the docs folder, the index.md file contains the main page of the site and the other markdown files contains other content of the site.

The site is split between 2 folders:

1. MIPS
2. Verilog

In MIPS, index.md contains the main page of the MIPS section and the other markdown files contain the content of the MIPS section.

In Verilog, index.md contains the main page of the Verilog section and the other markdown files contain the content of the Verilog section.