README.md

NU IoT Lab Website

This repository contains the source code for the NU IoT Lab website built with MkDocs Material theme.

Prerequisites

• Python 3.x
• Git

Local Development Setup

1. Clone the repository:

   git clone https://github.com/nu-iot-lab/nu-iot-lab.github.io.git
   cd nu-iot-lab.github.io

2. Create a virtual environment:

   python -m venv venv

3. Activate the virtual environment:

   On macOS/Linux:

   source venv/bin/activate

   On Windows:

   .\venv\Scripts\activate

4. Install dependencies:

   pip install -r requirements.txt

5. Start the development server:

   mkdocs serve

   The site will be available at http://127.0.0.1:8000

Note

Available Commands for mkdocs

• Build the documentation:

  mkdocs build

• Deploy to GitHub Pages:

  mkdocs gh-deploy

• Create a new project:

  mkdocs new [dir-name]

Project Structure

├── docs/               # Documentation source files 
├── overrides/          # Theme customization files
├── .github/            # GitHub Actions workflows 
├── mkdocs.yml          # MkDocs configuration 
└── requirements.txt    # Python dependencies

Publications

Adding New Publications

1. Add your BibTeX citation to publications.bib file

2. Use a unique citation key in the format: author_year_keyword

   Example BibTeX entry:

   @article{smith_2023_iot,
       author  = {Smith, John and Doe, Jane},
       title   = {IoT Security Analysis},
       journal = {IEEE IoT Journal},
       year    = {2023},
       volume  = {15},
       number  = {2},
       pages   = {123-145}
   }

Citing in Content

To reference a publication in any markdown page from publications.bib:

This is discussed in [@smith_2023_iot].

Publications are automatically rendered as footnotes using mkdocs-bibtex plugin.

Important

Ensure your BibTeX entries are properly formatted to avoid rendering issues.

License

This project is licensed under the MIT License.