You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-31
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ MedVIC Lab website
4
4
5
5
## Development
6
6
7
-
Look at the [Content documentation](https://content.nuxt.com/) to learn more.
7
+
Look at the official [VitePress documentation](https://vitepress.dev/) to learn more.
8
8
9
9
### Setup
10
10
@@ -17,7 +17,7 @@ yarn install
17
17
18
18
### Development Server
19
19
20
-
Start the development server on localhost:3000
20
+
Start the development server on localhost:5173
21
21
22
22
```bash
23
23
yarn dev
@@ -31,7 +31,7 @@ Build the application for production:
31
31
yarn build
32
32
```
33
33
34
-
Locally preview production build:
34
+
Locally preview production build: (port 4173)
35
35
36
36
```bash
37
37
yarn preview
@@ -89,15 +89,8 @@ To add yourself to the MedVIC Lab website, follow these steps:
89
89
git push origin [branch name]
90
90
```
91
91
92
-
5. **Generate the members list:**
93
-
- Run the build command to generate the `members.json` file and build the VitePress site.
94
-
95
-
```bash
96
-
yarn build
97
-
```
98
-
99
-
6. **Preview your changes:**
100
-
- Locally preview the production build to ensure your profile appears correctly.
92
+
5. **Preview your changes:**
93
+
- Locally preview the production build to ensure your profile appears correctly. You can also use `yarn dev` for active development.
101
94
102
95
```bash
103
96
yarn preview
@@ -133,7 +126,7 @@ To add a publication to the MedVIC Lab website, follow these steps:
133
126
- Below the frontmatter, add any additional information about the publication.
134
127
135
128
```markdown
136
-
# Publication Title
129
+
## Publication Information
137
130
138
131
Abstract or additional information about the publication.
139
132
```
@@ -147,15 +140,8 @@ To add a publication to the MedVIC Lab website, follow these steps:
147
140
git push origin [branch name]
148
141
```
149
142
150
-
5. **Generate the publications list:**
151
-
- Run the build command to generate the `publications.json` file and build the VitePress site.
152
-
153
-
```bash
154
-
yarn build
155
-
```
156
-
157
-
6. **Preview your changes:**
158
-
- Locally preview the production build to ensure your publication appears correctly.
143
+
5. **Preview your changes:**
144
+
- Locally preview the production build to ensure your publication appears correctly. You can also use `yarn dev` for active development.
159
145
160
146
```bash
161
147
yarn preview
@@ -211,18 +197,17 @@ To add a project to the MedVIC Lab website, follow these steps:
211
197
git push origin [branch name]
212
198
```
213
199
214
-
5. **Generate the projects list:**
215
-
- Run the build command to generate the `projects.json` file and build the VitePress site.
200
+
5. **Preview your changes:**
201
+
- Locally preview the production build to ensure your project appears correctly. You can also use `yarn dev` for active development.
216
202
217
203
```bash
218
-
yarn build
204
+
yarn preview
219
205
```
220
206
221
-
6. **Preview your changes:**
222
-
- Locally preview the production build to ensure your project appears correctly.
207
+
### Adding new pages
223
208
224
-
```bash
225
-
yarn preview
226
-
```
209
+
To add any page, simply put a markdown file in the `pages` directory. You can reference this as you would any other file. Reference the [VitePress documentation](https://vitepress.dev/) for specific details about layouts, styling, etc.
210
+
211
+
### Adding custom components
227
212
228
-
By following these steps, you can add yourself, publications, and projects to the MedVIC Lab website and ensure they are displayed correctly.
213
+
Reference the [official component documentation](https://vitepress.dev/guide/using-vue#using-components) for adding custom Vue components to the repository and files.
0 commit comments