|
1 | | -# Website |
| 1 | +## Maintaining the website on Github |
2 | 2 |
|
3 | | -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. |
4 | | - |
5 | | -### Installation |
6 | | - |
7 | | -``` |
8 | | -$ yarn |
9 | | -``` |
10 | | - |
11 | | -### Local Development |
12 | | - |
13 | | -``` |
14 | | -$ yarn start |
15 | | -``` |
16 | | - |
17 | | -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
| 3 | +Subpages have "edit this page link" at the bottom. I tried to make the formatting as easy as possible for editing |
| 4 | +- to add a Blogs or News entry, you just create a markdown file under the blogs or news folder. |
| 5 | +- To add a user, modify the facultyMembers, phdStudents or alumni arrays in docs/member.mdx |
| 6 | +- to edit the projects page, edit docs/projects.md file. |
| 7 | +- to edit the join us page, edit the docs/join-us.md file. |
18 | 8 |
|
19 | | -### Build |
| 9 | +Editing the landing page is tricky but minor edits are easy: |
| 10 | +- the quote under the slider is kept in /src/pages/index.js |
| 11 | +- the text for Grad/Undergrad Students are kept in /src/components/HomepageFeatures/index.js |
| 12 | +- Recent news holds the most recent 4 news automatically. no need to edit that. |
| 13 | +- sponsor thank you note is kept in /src/components/SponsorBanner.js |
| 14 | +- sponsor logos are under /static/img/logos, just add/remove an image and it updates automatically. |
20 | 15 |
|
21 | | -``` |
22 | | -$ yarn build |
23 | | -``` |
| 16 | +## Local development |
24 | 17 |
|
25 | | -This command generates static content into the `build` directory and can be served using any static contents hosting service. |
26 | | - |
27 | | -### Deployment |
28 | | - |
29 | | -Using SSH: |
30 | | - |
31 | | -``` |
32 | | -$ USE_SSH=true yarn deploy |
33 | | -``` |
34 | | - |
35 | | -Not using SSH: |
36 | | - |
37 | | -``` |
38 | | -$ GIT_USER=<Your GitHub username> yarn deploy |
39 | | -``` |
| 18 | +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. |
40 | 19 |
|
41 | | -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
| 20 | +### Installation |
| 21 | +`Bash |
| 22 | +$ npm install |
| 23 | +` |
| 24 | +This command installs all the necessary dependencies for your project. |
| 25 | + |
| 26 | +`Bash |
| 27 | +$ npm run start -- --poll |
| 28 | +` |
| 29 | +This command starts a local development server and typically opens up a browser window. Most changes are reflected live without having to restart the server. |
0 commit comments