This web page is hosted on GitHub Pages, as a static website, created by a website generator called VuePress.
To contribute to this main repository, you need to be invited as the collaborator first (ideally one from each team). Then the workflow is as followed:
- Clone (not fork) the repository: https://github.com/nusrobomaster/nusrobomaster.github.io
- Make sure you are on
docs
branch
- Make sure you are on
- [Important] checkout a new branch, with
dev/
prefix, for exampledev/your-team-name
- Make modifications as you wish
- Create a
your-team-name.md
file undernav-teams
folder
- Create a
- When the changes are done, commit by command
git commit
- Push your changes to the remote server when ready
- Make a pull request, from your
dev/your-team-name
branch todocs
branch - Once the pull request is approved, the website will be automatically updated by Travis CI, happy surfing!
When you are making changes to the markdown files, you would like to preview how the web page is generated. Yes, you can! This is how you do it.
- make sure nodejs and npm is installed
- in the git top folder, execute
npm install
, this will install the javascript dependencies - then, execute
npm run serve
, and follow the instructions to open the localhost link, to see the preview!