Skip to content

Project Overview

This is a project aimed at sharing the informations about courses in ZJU-SIS(School of International Studies) Contributors can upload their experiences or notes about courses including compulsory majors and the non-compulsory ones.

How to contribute

The whole project is based on mkdocs. Anyone who want to contribute for this project need to convert you documents into markdown. Using the mkdocs tool, static websites can be automatically built from your markdown file. For full documentation of how to use markdown, visitmkdocs.org.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Contributors