Skip to content

Commit 974b1c5

Browse files
committed
Remove unnecessary build steps
1 parent 8600292 commit 974b1c5

File tree

4 files changed

+5
-41
lines changed

4 files changed

+5
-41
lines changed

Diff for: README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,13 @@ The GDDocs website can be found [here](https://docs.gdprogra.me/#/)
1717

1818
GDDocs is built off of the `docsify` engine, outputted to a generator file to be able to work well on server environments, rather than GitHub pages. This is primarily to allow for easy domain usage and development in a place where it can always update, and be hosted upon locally rather than over GitHub's servers.
1919

20-
As such, rather than having to install using the package.json; (which we would recommended doing anyways using `npm install`,) the installation and such has been included in `generator.js`.
21-
22-
```plain
23-
node generator.js
20+
```sh
21+
npm install
22+
npm run run
2423
```
2524

2625
To debug it, you will need to properly clone or pull this repository.
2726

2827
## Contributing
2928

30-
Contributions are preferably made to the documentation, rather than the simple `generator.js` file; unless need be. Contributions to all aspects of this project are preferred to be made over pull requests and issues. Ideas on what to contribute or read over can be read in the [issues](https://github.com/gd-programming/gddocs/issues) section of this repository.
31-
29+
Contributions to all aspects of this project are preferred to be made over pull requests and issues. Ideas on what to contribute or read over can be read in the [issues](https://github.com/gd-programming/gddocs/issues) section of this repository.

Diff for: generator.js

-19
This file was deleted.

Diff for: package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "GD Documentation",
55
"main": "generator.js",
66
"scripts": {
7-
"run": "node generator.js"
7+
"run": "docsify serve ./docs --port 9505"
88
},
99
"repository": {
1010
"type": "git",
@@ -20,7 +20,6 @@
2020
},
2121
"homepage": "https://github.com/gd-programming/gddocs#readme",
2222
"dependencies": {
23-
"chalk": "^4.0.0",
2423
"docsify-cli": "^4.4.0"
2524
}
2625
}

Diff for: scripts/installPackages.js

-14
This file was deleted.

0 commit comments

Comments
 (0)