https://github.com/oaklight/mgwb
https://github.com/oaklight/mgwb
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/oaklight/mgwb
- Owner: Oaklight
- Created: 2024-03-04T03:31:03.000Z (over 2 years ago)
- Default Branch: website
- Last Pushed: 2024-09-28T09:02:08.000Z (over 1 year ago)
- Last Synced: 2025-09-18T14:13:27.848Z (9 months ago)
- Size: 845 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mango-website
this branch hosts project page related files
## Setup
Build with MkDocs
```bash
pip install mkdocs
pip install mkdocs-material
```
## Deploy
deploy to github pages
```bash
mkdocs gh-deploy
```
## push and deploy to different repos
say we have `origin` as git remote in the beginning, and we want to use an additional `mgwb` repo to track the development of the website.
First, add the new remote repo:
`git remote add temphosting git@github.com:Oaklight/mgwb.git`
When pull code changes:
```bash
git pull origin # if changes were synced to origin
git pull temphosting # if changes were synced to temphosting
```
When push code changes:
```bash
git push origin
git push temphosting
```
when deploy gh-pages:
```bash
mkdocs gh-deploy -r origin
mkdocs gh-deploy -r temphosting
```
## Structure
```bash
./mango-website/
├── docs
│ ├── assets
│ │ └── images
│ │ ├── mango.png
│ │ └── ...
│ ├── contact.md
│ ├── data.md
│ └── index.md
├── mkdocs.yml
└── README.md
```
- `assets`
images are stored in `docs/assets/images` folder
any other assets should be stored in `docs/assets` folder
- `docs` markdown templates
`docs/index.md` is the home page
`docs/data.md` is the data detail page
`docs/contact.md` is the contact page
any other pages should be added to `docs` folder and linked in `mkdocs.yml`