Skip to content

Commit

Permalink
Implemented wyam documentation
Browse files Browse the repository at this point in the history
fixes #11
  • Loading branch information
AdmiringWorm committed Jul 31, 2017
1 parent eaae9d7 commit 3f90a8e
Show file tree
Hide file tree
Showing 17 changed files with 404 additions and 0 deletions.
3 changes: 3 additions & 0 deletions config.wyam
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
System.Globalization.CultureInfo.DefaultThreadCurrentCulture = System.Globalization.CultureInfo.CreateSpecificCulture("en-GB");
Settings["LinkHideExtensions"] = true;
Settings["LinksUseHttps"] = true;
20 changes: 20 additions & 0 deletions docs/input/assets/css/override.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/* Control the margin for bootstrap alert boxes */
.alert > p {
margin-top: 0px;
}

/* Control the look and feel of the copy box applied to code sections */
.btn-copy[disabled] .clippy {
opacity: .3;
}
pre .btn-copy {
-webkit-transition: opacity 0.3s ease-in-out;
-o-transition: opacity 0.3s ease-in-out;
transition: opacity 0.3s ease-in-out;
opacity: 0;
padding: 2px 6px;
float: right;
}
pre:hover .btn-copy {
opacity: 1;
}
3 changes: 3 additions & 0 deletions docs/input/assets/images/clippy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/input/assets/js/anchor.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions docs/input/assets/js/clipboard.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions docs/input/blog/new-release-0.1.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
Title: New Release - 0.1.0
Published: 2017-03-11
Category: Release
Author: AdmiringWorm
---

# 0.1.0 Release

I'm happy to anounce the first public release of the Cake.Transifex library.

In this release, the following issue was resolved:

__Feature__

- [__#1__](https://github.com/WormieCorp/Cake.Transifex/issues/1) Initial Release
16 changes: 16 additions & 0 deletions docs/input/blog/new-release-0.2.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
Title: New Release - 0.2.0
Published: 2017-05-17
Category: Release
Author: AdmiringWorm
---

# 0.2.0 Release

As part of this release we had [1 issue](https://github.com/WormieCorp/Cake.Transifex/issues?milestone=2&state=closed) closed.


__Enhancement__

- [__#4__](https://github.com/WormieCorp/Cake.Transifex/issues/4) Support additional modes when pulling translations

7 changes: 7 additions & 0 deletions docs/input/docs/building/index.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
Order: 3
Description: How to build the Cake.Transifex library
---
<p>@Html.Raw(Model.String(DocsKeys.Description))</p>

@Html.Partial("_ChildPages")
27 changes: 27 additions & 0 deletions docs/input/docs/building/linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
Order: 2
Title: Building on Linux
Author: Kim Nordmo
---

## Requirements

The following are need to build Cake.Transifex on Windows:
- .NET Core SDK 1.0.4 *(could work with other versions as well)*
- Mono 4.2.3+ *(earlier versions may work, but are not supported)*

All other dependencies will be automatically downloaded when invoking the build script.

## Invoking the build itself

1. To build the Cake.Transifex library, just open any shell and navigate to the root of
downloaded/cloned repository.
2. After that just type `sh build.sh` and everything will be automatically built and all unit tests
will run.

**NOTE:** There is currently a small bug in some versions of the .NET Core library wich causes
a build failure when trying to use the `dotnet` utility,
to work around this problem you will need to export the path to the mono library directory by
doing the following before calling the build script:
`export FrameworkPathOverride=/usr/lib/mono/4.5/`
*(Change the path to the actual location of your mono installation directory)*
11 changes: 11 additions & 0 deletions docs/input/docs/building/macos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
Order: 3
Title: Building on OSX
ValidateLinksAsError: true
Author: Kim Nordmo
---

Building on MAC OSX is highly untested, and any contribution to document
the build process would be greatly appreciated.

In the meantime, try following the *[Building on Linux](linux)* documentation.
27 changes: 27 additions & 0 deletions docs/input/docs/building/windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
Order: 1
Title: Building on Windows
Author: Kim Nordmo
---

## Requirements

The following are need to build Cake.Transifex on Windows:
- Visual Studio 2017
- .NET Core SDK 1.0.4 *(could work with other versions as well)*
- .NET Framework 4.5

All other dependencies will be automatically downloaded when invoking the build script.

## Invoking the build itself

1. To build the Cake.Transifex library, just open powershell and navigate to the root of
downloaded/cloned repository.
2. After that just type `.\build.ps1` and everything will be automatically built and all unit tests
will run.

## Creating a redistributable nuget package

To create a nuget package you can follow the same process as when building the library,
with the exception of calling `.\build.ps1` without any arguments.
The only difference is to run the build script with the following: `.\build.ps1 -Target Package`.
Loading

0 comments on commit 3f90a8e

Please sign in to comment.