CSI website

The CSI website is built using the Material for MkDocs. You just need to work on markdown files and MKdocs will render them to proper web pages.

Setup

1. Clone the repo

git clone https://github.com/X-lab-3D/csi/

cd csi

2. Create a python virtual environment and activate it

conda create -n csi python=3.13
conda activate csi

3. Install the required packages

pip install -r requirements.txt

4. Monitor local changes

mkdocs serve -w docs -w mkdocs.yml

then you can open http://127.0.0.1:8000/ in your browser to view the website.

Add a new page

For example, we want to add a new page with title "Posters". You can follow these steps:

1. Add a new markdown file in the docs directory, e.g., docs/posters.md.
2. Update mkdocs.yml to add the new page under the nav section:

nav:
- About: index.md
- Schedule: schedule.md
- Posters: posters.md

3. Then you can go to http://127.0.0.1:8000/posters/ to check the new page.

4. Add new content to the docs/posters.md file with markdown format. To make the content fancier, you can check the Material for MkDocs.

Add an announcement

To add an announcement to the website, you can follow these steps:

1. Open the overrides/main.html file.
2. Locate the {% block announce %} section.
3. Add your announcement content inside the <div class="announcement"> tags. You can use HTML markup to format the content as needed.

For example, you can add a new announcement like this:

{% block announce %}
  <div class="announcement">
    <p>🔥 <a href="https://x-lab-3d.github.io/csi/2025/participants/#participants">90+ participants</a> from 18 research institutes and 12 companies will attend CSI2025! </p>
  </div>
{% endblock %}

Publish the changes

Once you are satisfied with your changes, you can push your commits to the remote main branch, then a github action will automatically deploy the changes to github pages.

In the github action, mike is used to publish the changes:

mike deploy --push --update-aliases 2025 latest

If you want to publish a new website for e.g. CSI2026, then you update the action to

mike deploy --push --update-aliases 2026 latest