-
-
Notifications
You must be signed in to change notification settings - Fork 485
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deploy docs to GH Pages #293
Conversation
@lancedikson (or any other maintainers): any questions or feedback on this? I maybe should have mentioned it in the commit: I tested the |
Hi, @SterlingVix. Sorry for the silence. Sounds great, but I didn't have a chance to have a look at it. I'll try to review and release it at the beginning of the week. |
Thanks @lancedikson , and no problem, of course. 😉 Please let me know if I can do anything to help. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems fine, will merge soon
@lancedikson - I may not have been clear, but, as the repo owner, you'll have to run Once you My apologies if that wasn't clear in the PR. |
@SterlingVix, thanks, but yeah, I know how it works, it's just hadn't enough time to make a release with proper changelogs and everything. Will do that today :) Sorry for the delay. |
No problem, hope I'm not bugging you! I'll leave it in your capable hands. 👍 |
I noticed that the README promised a docs page soon, and that the docs pages worked, but just needed serving.
I added a
deploy
script which runs gh-pages: https://github.com/tschaub/gh-pages#command-line-utilityWhen you enter
npm run deploy
it will regenerate the docs and push to thegh-pages
branch. The docs files are then visible at https://lancedikson.github.io/bowser/docs (also linked in README.md).I hope this helps. :)
PS - I noticed I had a failing test during my local build, but I didn't touch any source code, so I assume that's a false negative.