-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from ThaiProgrammer/develop
Develop
- Loading branch information
Showing
24 changed files
with
2,153 additions
and
36 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,34 @@ | ||
# tpa-path | ||
# tpa-path | ||
|
||
## Installation | ||
### Prerequisites | ||
- [Node.js](https://nodejs.org/) version 18 or higher. | ||
- Terminal for accessing VitePress via its command line interface (CLI). | ||
- Text Editor with [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax support. | ||
- [VSCode](https://code.visualstudio.com/) is recommended, along with the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar). | ||
|
||
VitePress can be used on its own, or be installed into an existing project. In both cases, you can install it with: | ||
|
||
```bash | ||
$ npm add -D vitepress | ||
``` | ||
|
||
### Up and Running | ||
The tool should have also injected the following npm scripts to your `package.json` if you allowed it to do so during the setup process: | ||
|
||
```json | ||
{ | ||
... | ||
"scripts": { | ||
"docs:dev": "vitepress dev docs", | ||
"docs:build": "vitepress build docs", | ||
"docs:preview": "vitepress preview docs" | ||
}, | ||
... | ||
} | ||
``` | ||
The `docs:dev` script will start a local dev server with instant hot updates. Run it with the following command: | ||
|
||
```bash | ||
$ npm run docs:dev | ||
``` |
Oops, something went wrong.