AskDavis/Getting-Started-With-ACPI
1
0
Fork 0
mirror of https://github.com/AskDavis/Getting-Started-With-ACPI.git synced 2026-01-01 05:05:57 -08:00
Code Issues Packages Projects Releases Wiki Activity

Fix travis

Browse Source
This commit is contained in:
Mykola Grymalyuk
2020-07-17 15:01:14 -06:00
parent 43e6a8dc21
commit 75083d8584
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -39,17 +39,17 @@ Some guidelines when contributing via PRs:
### How to Contribute
Best way to test your commits and make sure they are formatted correctly is downloading `nodejs` and getting the [gitbook-cli](https://github.com/GitbookIO/gitbook-cli) and [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) tools. When you run `gitbook serve`, it will set up a local webserver which you can connect to view the changes you made. `markdownlint *` will throw any errors at you about formatting as well, and `markdownlint -f *` will attempt to fix these.
Best way to test your commits and make sure they are formatted correctly is downloading `nodejs` and `yarn` then getting the VuePress and [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) tools. When you run `yarn dev`, it will set up a local webserver which you can connect to view the changes you made. `markdownlint *` will throw any errors at you about formatting as well, and `markdownlint -f *` will attempt to fix these.
* [Fork this repo](https://github.com/dortania/Getting-Started-With-ACPI/fork/)
* Install the required tools:
* `brew install yarn`
* `npm install -g markdownlint-cli`
* `npm install -g gitbook-cli`
* Make your changes.
* Build the site:
* `gitbook install` (To install all the required gitbook plugins)
* `gitbook serve` (Preview the site)
* Can be found at `http://localhost:4000`
* `yarn install` (To install all the required plugins)
* `yarn dev` (Preview the site)
* Can be found at `http://localhost:8080`
* Check markdown format:
* `markdownlint -f *` (To fix any potential issues)