From eb177c97885f81d083de9dc89c0280925a14f5c3 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Thu, 2 Feb 2017 08:04:05 +0000 Subject: [PATCH] (GH-15) Added Wyam Docs --- README.md | 4 ++++ docs/input/docs/index.cshtml | 19 +++++++++++++++++++ docs/input/docs/usage/index.cshtml | 7 +++++++ docs/input/index.cshtml | 13 +++++++++++++ 4 files changed, 43 insertions(+) create mode 100644 docs/input/docs/index.cshtml create mode 100644 docs/input/docs/usage/index.cshtml create mode 100644 docs/input/index.cshtml diff --git a/README.md b/README.md index 025e685..7c339cf 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@ Cake.Chutzpah is an Addin for [Cake](http://cakebuild.net/) to allow the executi [![Coverage Status](https://coveralls.io/repos/github/cake-contrib/Cake.Chutzpah/badge.svg?branch=develop)](https://coveralls.io/github/cake-contrib/Cake.Chutzpah?branch=develop) +## Quick Links + +- [Documentation](https://cake-contrib.github.io/Cake.Chutzpah/) + ## Chat Room Come join in the conversation about Cake.Chutzpah in our Gitter Chat Room diff --git a/docs/input/docs/index.cshtml b/docs/input/docs/index.cshtml new file mode 100644 index 0000000..ca3efa0 --- /dev/null +++ b/docs/input/docs/index.cshtml @@ -0,0 +1,19 @@ +--- +Title: Documentation +--- +

This user guide, like Cake.Chutzpah itself, is under very active development. Some parts of it aren't +documented as completely as they need to be, but we glady accept your contributions.

+ +

We need your help to improve the documentation for Cake.Chutzpah, so if there is something that you +would like to add then you can edit the content directly on GitHub.

+ +@foreach(IDocument child in Model.DocumentList(Keys.Children).OrderBy(x => x.Get(DocsKeys.Order, 1000))) +{ +

@(child.String(Keys.Title))

+ if(child.ContainsKey(DocsKeys.Description)) + { +

@Html.Raw(child.String(DocsKeys.Description))

+ } + + @Html.Partial("_ChildPages", child) +} \ No newline at end of file diff --git a/docs/input/docs/usage/index.cshtml b/docs/input/docs/usage/index.cshtml new file mode 100644 index 0000000..533a856 --- /dev/null +++ b/docs/input/docs/usage/index.cshtml @@ -0,0 +1,7 @@ +--- +Order: 2 +Description: How to obtain, configure, and execute Cake.Chutzpah. +--- +

@Html.Raw(Model.String(DocsKeys.Description))

+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/input/index.cshtml b/docs/input/index.cshtml new file mode 100644 index 0000000..8ff3bfe --- /dev/null +++ b/docs/input/index.cshtml @@ -0,0 +1,13 @@ +--- +Title: Cake.Chutzpah +NoSidebar: true +NoContainer: false +NoGutter: true +--- + +
+

What is it?

+

+ Cake.Chutzpah is an Addin for Cake which allows the execution of the command line JavaScript test runner. +

+
\ No newline at end of file