Skip to content

Commit

Permalink
refactor: Fix readme for npm and new vitpress folder
Browse files Browse the repository at this point in the history
  • Loading branch information
fuzoh committed Jan 20, 2024
1 parent f01eb7d commit 5c0ed08
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@
1. Create a new repository using this template repository (click on the green button "Use this template").
2. Clone your new repository on your machine.
3. Edit your base information :
- In `.vitpress/config.mts` :
- In `src/.vitpress/config.mts` :
- Change the `base` property to your repository name (if you have set a custom repository name).
- Change the `title` property with your name or pseudo.
- Change the `socialLinks`property with your GitHub repository link.
- In `index.md` :
- In `src/index.md` :
- Change the `name` property with your name or pseudo.
4. Install dependencies and run the dev server :
```bash
npm install # or pnpm i
npm run dev # or pnpm dev
npm install
npm run dev
```

## How to add your content

## Deployment

Normally, you don't need to deploy your website. It will be automatically deployed by Github Pages when you push your changes to the `main` branch. You can access your website at the following address : `https://<your-github-username>.github.io/<your-repository-name>/`.
> Y may need to activate Github Pages in your repository settings and wait a few minutes for the first build to be completed.
> You may need to activate Github Pages in your repository settings and wait a few minutes for the first build to be completed.

0 comments on commit 5c0ed08

Please sign in to comment.