-
Notifications
You must be signed in to change notification settings - Fork 71
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
Port to gh-pages #74
Comments
Perhaps the first step of this is to generate static API documentation from the source code. Perhaps the main repo should have a This would also make it a lot easier on products such as dash to integrate our documentation. We should be sure to communicate with them and others of this change. The plugins section is the major reason this has not yet occurred. #34 seems like the best way to do this, but open to other ideas if you have them. Given the importance of plugins for the Chai ecosystem and their statistical contribution to website traffic it would be ill-advised to abandon that section completely. I will continue to release manually as long as needed, but a more hands-off approach would be preferable. |
I like the idea of main repo having docs, perhaps every doc could be both .md and .json - so it was parseable by a static site generator (and maybe dash & co would prefer that also?). I've raised chaijs/chai#378 to discuss further. I've continued discussion on plugins over in #34. I'm pretty positive about where we can go with this. I think if we look at wrapping up both #34 and chaijs/chai#378, we can then reinvestigate what it would take here to make this an automatic process. |
I've put up a very much WIP of a jekyll site, which ports over the existing site to jekyll pages. I'll be working on it some this weekend, but anyone who wants to chip in, please feel free! |
How's this going? Any way I can contribute? :) |
Absolutely! Just pull down the gh-pages branch, and install jekyll ( You can also see the site here: https://chaijs.github.io/chai-docs/. The CSS is 404ing because we have a domain name for the main site (chaijs.com) and I havent spent the time to figure out how to get jekyll to work for both a domain and the github.io address, so the github.io address currently has no CSS. I might change it so that URLs are relative to |
I've just commented in #34 here: #34 (comment) about getting each of the chai-plugins to include the |
Spent a chunk of time on this over the weekend. The github.io page is looking a lot better now. There are still big missing bits though, as a rough list:
|
Closing this, in favour of making new issues which we can focus on. |
Given that the chai-docs website still requires manual intervention to release to http://chaijs.com, I propose we should switch the site over to Github's gh-pages. Here is a tentative to-do list of what needs to be done:
gh-pages
@logicalparadox will probably have better ideas about this - feel free to edit 😄
The text was updated successfully, but these errors were encountered: