https://github.com/traffic-alpha/sensing-communication-for-smart-city

Website for "Laboratory of Sensing and Communication for Smart City"
https://github.com/traffic-alpha/sensing-communication-for-smart-city

jekyll jekyll-site

Last synced: 4 months ago
JSON representation

Website for "Laboratory of Sensing and Communication for Smart City"

• Host: GitHub
• URL: https://github.com/traffic-alpha/sensing-communication-for-smart-city
• Owner: Traffic-Alpha
• License: apache-2.0
• Created: 2024-06-03T15:06:48.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-03T12:53:55.000Z (4 months ago)
• Last Synced: 2024-10-11T19:21:53.454Z (4 months ago)
• Topics: jekyll, jekyll-site
• Homepage:
• Size: 55.9 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Laboratory of Sensing and Communication for Smart City

This repository contains the website for the **Laboratory of Sensing and Communication for Smart City**.

## Installation

To modify the website content, you need to install the MkDocs with the Material theme. Install it using pip:

```bash

pip install mkdocs-material

```

## Running the Website Locally

To view and edit the website content in real-time, navigate to the project directory and run the following command:

```bash

mkdocs serve

```

This command starts a local web server that hosts the website. Any changes you make to the documentation source files will automatically rebuild the site and refresh the page in the browser.

## How to Submit Changes

First, update the repository to ensure you have the latest data:

```bash

git pull

```

Then, stage your changes and provide a descriptive commit message:

```bash

git add .

git commit -m "Describe the changes here"

```

Finally, push your changes to the repository:

```bash

git push

```

## File Structure

Below is a brief overview of the key files and directories in this repository:

- `mkdocs.yml`: The configuration file for the MkDocs project. This file includes settings for the MkDocs build and the plugins used for the website.

- `docs/`: Directory containing the Markdown files for the website's content. Each file corresponds to a page on the website.

  - `index.md`: The homepage document.

  - `pubs.md`: Contains information about published papers.

  - `members.md`: Introductions to the project members.