Overview
The documents package contains the necessary documentation to understand how the application works, and was written in MD compiled through vuepress.
Table of Contents
How to use
Docs
Directions
Go to the project directory in your consol.
cd D:pathtprojectdirectory/distanceDocs
1
Install project dependencies
npm install
1
Run locally
npm run docs:dev
1
Or Build
npm run docs:build
1
App Structure
Bellow is the current structure of the Distance Docs Package.
distanceDocs/
├── .vuepress/
│ ├── favicon.ico
│ └── index.html
├── docs/
│ ├── .vuepress/
│ │ ├── components/
│ │ │ └── logo.png
│ │ ├── dist/
│ │ │ └──
│ │ ├── public/
│ │ │ └──
│ │ ├── config.js
│ │ └── enhanceApp.js
│ ├── guide/
│ │ ├── Calculator.md
│ │ ├── Developer.md
│ │ ├── Docs.md
│ │ └── READEME.md
│ └── READEME.md
├── .gitignore
├── package.json
└── package-lock.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Important Docs Files
| file | Contents |
|---|---|
| Calculator.md | Contains md for the calculator package |
| Developer.md | Contains md for the developer package |
| Docs.md | Contains md for the docs package |
| guide/READEME.md | Contains the introduction page for guide/docs |
| config.js | Contains vuepress configuration settings and sidebars |