Skip to content

Commit

Permalink
(GH-15) Added Wyam Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gep13 committed Feb 2, 2017
1 parent ab5c909 commit eb177c9
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
19 changes: 19 additions & 0 deletions docs/input/docs/index.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
Title: Documentation
---
<p>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.</p>

<p>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.</p>

@foreach(IDocument child in Model.DocumentList(Keys.Children).OrderBy(x => x.Get<int>(DocsKeys.Order, 1000)))
{
<h1>@(child.String(Keys.Title))</h1>
if(child.ContainsKey(DocsKeys.Description))
{
<p>@Html.Raw(child.String(DocsKeys.Description))</p>
}

@Html.Partial("_ChildPages", child)
}
7 changes: 7 additions & 0 deletions docs/input/docs/usage/index.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
Order: 2
Description: How to obtain, configure, and execute Cake.Chutzpah.
---
<p>@Html.Raw(Model.String(DocsKeys.Description))</p>

@Html.Partial("_ChildPages")
13 changes: 13 additions & 0 deletions docs/input/index.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
Title: Cake.Chutzpah
NoSidebar: true
NoContainer: false
NoGutter: true
---

<div class="container">
<h1>What is it?</h1>
<p>
Cake.Chutzpah is an Addin for <a href="http://cakebuild.net/">Cake</a> which allows the execution of the command line JavaScript test runner.
</p>
</div>

0 comments on commit eb177c9

Please sign in to comment.