https://github.com/devtoys-app/documentation
API reference and tutorials on how to use DevToys and develop an extension
https://github.com/devtoys-app/documentation
Last synced: 3 months ago
JSON representation
API reference and tutorials on how to use DevToys and develop an extension
- Host: GitHub
- URL: https://github.com/devtoys-app/documentation
- Owner: DevToys-app
- License: mit
- Created: 2024-03-24T16:57:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-14T23:44:52.000Z (about 1 year ago)
- Last Synced: 2024-04-16T12:06:27.237Z (about 1 year ago)
- Size: 3.62 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
This is the documentation website of DevToys
# Setup this repository
Install [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download) or higher, then open a command line prompt and enter the following command:
```powershell
> git submodule update --init --recursive
> git submodule update --remote --merge
> dotnet tool update -g docfx
```
# How to build
```powershell
> docfx
```
# How to run locally
```powershell
> docfx --serve
```
Now you can preview the website on [http://localhost:8080/](http://localhost:8080/)
## Hot reload
Instead of running the command above, use NodeJS:
1. Install the dev dependencies by running:
```powershell
> npm install -D
```
2. Run:
```powershell
> npm run watch
```
> Note!
>
> If you are running the local server on Linux, replace the `watch` script with this:
> `npm-watch build & npm run browser-livereload`