Skip to content

Commit

Permalink
Remove unnecessary build steps
Browse files Browse the repository at this point in the history
  • Loading branch information
poweredbypie committed Apr 28, 2023
1 parent 8600292 commit 974b1c5
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 41 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,13 @@ The GDDocs website can be found [here](https://docs.gdprogra.me/#/)

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.

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`.

```plain
node generator.js
```sh
npm install
npm run run
```

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

## Contributing

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.

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.
19 changes: 0 additions & 19 deletions generator.js

This file was deleted.

3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "GD Documentation",
"main": "generator.js",
"scripts": {
"run": "node generator.js"
"run": "docsify serve ./docs --port 9505"
},
"repository": {
"type": "git",
Expand All @@ -20,7 +20,6 @@
},
"homepage": "https://github.com/gd-programming/gddocs#readme",
"dependencies": {
"chalk": "^4.0.0",
"docsify-cli": "^4.4.0"
}
}
14 changes: 0 additions & 14 deletions scripts/installPackages.js

This file was deleted.

0 comments on commit 974b1c5

Please sign in to comment.