Skip to content

Commit a90396d

Browse files
committed
Update documentation link for external docs
1 parent eb46159 commit a90396d

File tree

1 file changed

+16
-31
lines changed

1 file changed

+16
-31
lines changed

README.md

+16-31
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ MedVIC Lab website
44

55
## Development
66

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.
88

99
### Setup
1010

@@ -17,7 +17,7 @@ yarn install
1717

1818
### Development Server
1919

20-
Start the development server on localhost:3000
20+
Start the development server on localhost:5173
2121

2222
```bash
2323
yarn dev
@@ -31,7 +31,7 @@ Build the application for production:
3131
yarn build
3232
```
3333

34-
Locally preview production build:
34+
Locally preview production build: (port 4173)
3535

3636
```bash
3737
yarn preview
@@ -89,15 +89,8 @@ To add yourself to the MedVIC Lab website, follow these steps:
8989
git push origin [branch name]
9090
```
9191

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.
10194

10295
```bash
10396
yarn preview
@@ -133,7 +126,7 @@ To add a publication to the MedVIC Lab website, follow these steps:
133126
- Below the frontmatter, add any additional information about the publication.
134127

135128
```markdown
136-
# Publication Title
129+
## Publication Information
137130

138131
Abstract or additional information about the publication.
139132
```
@@ -147,15 +140,8 @@ To add a publication to the MedVIC Lab website, follow these steps:
147140
git push origin [branch name]
148141
```
149142

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.
159145

160146
```bash
161147
yarn preview
@@ -211,18 +197,17 @@ To add a project to the MedVIC Lab website, follow these steps:
211197
git push origin [branch name]
212198
```
213199

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.
216202

217203
```bash
218-
yarn build
204+
yarn preview
219205
```
220206

221-
6. **Preview your changes:**
222-
- Locally preview the production build to ensure your project appears correctly.
207+
### Adding new pages
223208

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
227212

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

Comments
 (0)