Team SG Heritage Wiki
App Concept
XXX is a mobile app aimed primarily at Singaporeans to walk around more and visit the city's heritage sites more despite their busy lifestyles. The app makes use of gamified features and incentives to instill habits of staying active and keeping Singapore's culture alive.
Wiki Folder layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Updating the Wiki
Wiki built with Mkdocs and hosted with nginx
Access VM via SSH tunnel in cmd
# actual site is hosted on port 80, mkdocs preview is on 8000
# -L 8000:localhost:8000 can be removed if you only wish to view the wiki
ssh -L 80:localhost:80 -L 8000:localhost:8000 teamXX@IPADDRESS
While accessing VM
$ source .venv/bin/activate #activate python venv for mkdocs to work
$ cd ./sgh300-wiki #change directory to mkdocs wiki
# if you'd like to preview your changes, do
$ mkdocs serve
# and go to http://localhost:8000/
# to build
$ mkdocs build #build html static site
$ sudo cp -r ./site/* /var/www/html #copy to folder ngnix build from
# updates should now be visible on http://localhost/
Other notes: I (Qi Ting) am using WinSCP to directly view and update the .md files instead of copying them over via CLI commands.