-
-
Notifications
You must be signed in to change notification settings - Fork 422
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(website): Add local development instructions for website to CONT…
…RIBUTING.md
- Loading branch information
Showing
3 changed files
with
56 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Repomix Website | ||
|
||
This directory contains the source code for the Repomix website, built with [VitePress](https://vitepress.dev/) and [Vue.js](https://vuejs.org/) | ||
|
||
## Prerequisites | ||
|
||
- Docker must be installed on your system | ||
|
||
## Development | ||
|
||
To start the development server: | ||
|
||
```bash | ||
# Start the website development server | ||
npm run website | ||
|
||
# Access the website at http://localhost:5173/ | ||
``` | ||
|
||
## Documentation | ||
|
||
When updating documentation, you only need to update the English version (`client/src/en/`). | ||
The maintainers will handle translations to other languages. | ||
|
||
## Building for Production | ||
|
||
To build the website for production: | ||
|
||
```bash | ||
npm run website:build | ||
``` | ||
|
||
The built files will be available in the `client/dist` directory. |