sympmarc / SPServices

SPServices is a jQuery library which abstracts SharePoint's Web Services and makes them easier to use. It also includes functions which use the various Web Service operations to provide more useful (and cool) capabilities. It works entirely client side and requires no server install.
MIT License
207 stars 62 forks source link

Enable documentation conversion from markdown to HTML #49

Closed joshmcrty closed 8 years ago

joshmcrty commented 8 years ago

I updated the Gulpfile.js docs task to use Metalsmith to build documentation in HTML format. I created a very simple template using Bootstrap, and I've got some more ideas on how to improve/enhance the navigation and organization of the documentation that I'll try to work on soon.

I did a couple of quick passes to check links, but I'm sure there are still some that may be broken or malformed after the markdown->html conversion. All documentation pages should be here and the build works without error by running the gulp docs task. Essentially the GitHub version of SPServices documentation should now be "all there."

Maintainers should be able to generate HTML documentation after pulling these changes and running npm install to get the new dependencies before running the gulp docs task.

A few pervasive changes that were needed: