API docs

[JimBobSquarePants]

Update

Docs are available at:
https://sixlabors.github.io/docs/

---

Original Issue

From @JimBobSquarePants on January 13, 2016 0:43

I would like to create documentation like the following:

http://dotnet.github.io/

MS are using the library below but I can't seem to follow the instructions.

http://dotnet.github.io/docfx/

Copied from original issue: JimBobSquarePants/ImageProcessor#297

[JimBobSquarePants]

From @robertjf on January 13, 2016 0:53

@JimBobSquarePants I have a little spare time at the moment and can take a look at it - have had a look through the walkthroughs etc.

Have you started a project for this in Visual Studio yet? If so do you want to check it in and I'll start with that, or do you want me to start from scratch? And is your preference to use Visual Studio IDE or configure it under dnx instead?

[JimBobSquarePants]

Awesome! Thanks mate 👍

I haven't started a project yet, I planned to set a docs folder and stick a web project in there to do it all so I could preview.

[JimBobSquarePants]

From @priyanshu92 on May 5, 2016 15:42

@JimBobSquarePants I looked at it and created a sample documentation following their tutorials and I was able to create it but it doesn't seem to work on .NET Core projects 😕 with project extension as **.xproj. I think currently it only supports .csproj files. 😞

Let me know if I can help.

[JimBobSquarePants]

@priyanshu92 Thanks for giving it a go, I had issues myself when I tried. Maybe I should look elsewhere for something to use.

Ideally I want something people can make pull requests against. I just wish Jekyll wasn't such a chore on Windows machines.

[M-Zuber]

Volunteering to try and kickstart this.

[JimBobSquarePants]

You're on! 😄 That would be awesome!

If possible I would like to get them to build into a /docs/ folder so that I can host from github pages easily.

[daveaglick]

@M-Zuber Not sure you've been following along, but the Wyam docs recipe is almost done! I'm getting Cake up and running first, but the Recipe in general should be just about ready. I merged it into the develop branch last week and a release should be coming in 2-3 weeks.

[daveaglick]

[M-Zuber]

I didn't forget, RL has been very the last bit.
But it is in in my schedule for today :fingers-crossed:

[M-Zuber]

It seems that docfx does not yet support xproj/project.json 😢