From 3f90a8e6e2f3825b45cb9c084576d480cdf11d71 Mon Sep 17 00:00:00 2001 From: AdmiringWorm Date: Mon, 31 Jul 2017 14:42:08 +0200 Subject: [PATCH] Implemented wyam documentation fixes #11 --- config.wyam | 3 + docs/input/assets/css/override.css | 20 ++++ docs/input/assets/images/clippy.svg | 3 + docs/input/assets/js/anchor.min.js | 6 ++ docs/input/assets/js/clipboard.min.js | 7 ++ docs/input/blog/new-release-0.1.0.md | 16 +++ docs/input/blog/new-release-0.2.0.md | 16 +++ docs/input/docs/building/index.cshtml | 7 ++ docs/input/docs/building/linux.md | 27 +++++ docs/input/docs/building/macos.md | 11 ++ docs/input/docs/building/windows.md | 27 +++++ docs/input/docs/index.cshtml | 19 ++++ docs/input/docs/usage/contributing.md | 33 ++++++ docs/input/docs/usage/index.cshtml | 7 ++ docs/input/docs/usage/intro.md | 26 +++++ docs/input/index.cshtml | 26 +++++ docs/packages.xml | 150 ++++++++++++++++++++++++++ 17 files changed, 404 insertions(+) create mode 100644 config.wyam create mode 100644 docs/input/assets/css/override.css create mode 100644 docs/input/assets/images/clippy.svg create mode 100644 docs/input/assets/js/anchor.min.js create mode 100644 docs/input/assets/js/clipboard.min.js create mode 100644 docs/input/blog/new-release-0.1.0.md create mode 100644 docs/input/blog/new-release-0.2.0.md create mode 100644 docs/input/docs/building/index.cshtml create mode 100644 docs/input/docs/building/linux.md create mode 100644 docs/input/docs/building/macos.md create mode 100644 docs/input/docs/building/windows.md create mode 100644 docs/input/docs/index.cshtml create mode 100644 docs/input/docs/usage/contributing.md create mode 100644 docs/input/docs/usage/index.cshtml create mode 100644 docs/input/docs/usage/intro.md create mode 100644 docs/input/index.cshtml create mode 100644 docs/packages.xml diff --git a/config.wyam b/config.wyam new file mode 100644 index 0000000..5b69b4d --- /dev/null +++ b/config.wyam @@ -0,0 +1,3 @@ +System.Globalization.CultureInfo.DefaultThreadCurrentCulture = System.Globalization.CultureInfo.CreateSpecificCulture("en-GB"); +Settings["LinkHideExtensions"] = true; +Settings["LinksUseHttps"] = true; diff --git a/docs/input/assets/css/override.css b/docs/input/assets/css/override.css new file mode 100644 index 0000000..467b2fb --- /dev/null +++ b/docs/input/assets/css/override.css @@ -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; +} diff --git a/docs/input/assets/images/clippy.svg b/docs/input/assets/images/clippy.svg new file mode 100644 index 0000000..a06cc7a --- /dev/null +++ b/docs/input/assets/images/clippy.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/input/assets/js/anchor.min.js b/docs/input/assets/js/anchor.min.js new file mode 100644 index 0000000..44431c2 --- /dev/null +++ b/docs/input/assets/js/anchor.min.js @@ -0,0 +1,6 @@ +/** + * AnchorJS - v3.2.2 - 2016-10-05 + * https://github.com/bryanbraun/anchorjs + * Copyright (c) 2016 Bryan Braun; Licensed MIT + */ +!function(A,e){"use strict";"function"==typeof define&&define.amd?define([],e):"object"==typeof module&&module.exports?module.exports=e():(A.AnchorJS=e(),A.anchors=new A.AnchorJS)}(this,function(){"use strict";function A(A){function e(A){A.icon=A.hasOwnProperty("icon")?A.icon:"",A.visible=A.hasOwnProperty("visible")?A.visible:"hover",A.placement=A.hasOwnProperty("placement")?A.placement:"right",A.class=A.hasOwnProperty("class")?A.class:"",A.truncate=A.hasOwnProperty("truncate")?Math.floor(A.truncate):64}function t(A){var e;if("string"==typeof A||A instanceof String)e=[].slice.call(document.querySelectorAll(A));else{if(!(Array.isArray(A)||A instanceof NodeList))throw new Error("The selector provided to AnchorJS was invalid.");e=[].slice.call(A)}return e}function n(){if(null===document.head.querySelector("style.anchorjs")){var A,e=document.createElement("style"),t=" .anchorjs-link { opacity: 0; text-decoration: none; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; }",n=" *:hover > .anchorjs-link, .anchorjs-link:focus { opacity: 1; }",i=' @font-face { font-family: "anchorjs-icons"; src: url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype"); }',o=" [data-anchorjs-icon]::after { content: attr(data-anchorjs-icon); }";e.className="anchorjs",e.appendChild(document.createTextNode("")),A=document.head.querySelector('[rel="stylesheet"], style'),void 0===A?document.head.appendChild(e):document.head.insertBefore(e,A),e.sheet.insertRule(t,e.sheet.cssRules.length),e.sheet.insertRule(n,e.sheet.cssRules.length),e.sheet.insertRule(o,e.sheet.cssRules.length),e.sheet.insertRule(i,e.sheet.cssRules.length)}}this.options=A||{},this.elements=[],e(this.options),this.isTouchDevice=function(){return!!("ontouchstart"in window||window.DocumentTouch&&document instanceof DocumentTouch)},this.add=function(A){var i,o,s,c,r,a,h,l,u,d,f,p,w=[];if(e(this.options),p=this.options.visible,"touch"===p&&(p=this.isTouchDevice()?"always":"hover"),A||(A="h1, h2, h3, h4, h5, h6"),i=t(A),0===i.length)return!1;for(n(),o=document.querySelectorAll("[id]"),s=[].map.call(o,function(A){return A.id}),r=0;r-1,t=A.lastChild&&(" "+A.lastChild.className+" ").indexOf(" anchorjs-link ")>-1;return e||t||!1}}return A}); \ No newline at end of file diff --git a/docs/input/assets/js/clipboard.min.js b/docs/input/assets/js/clipboard.min.js new file mode 100644 index 0000000..1d7c5d5 --- /dev/null +++ b/docs/input/assets/js/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v1.5.16 + * https://zenorocha.github.io/clipboard.js + * + * Licensed MIT © Zeno Rocha + */ +!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var t;t="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,t.Clipboard=e()}}(function(){var e,t,n;return function e(t,n,i){function o(a,c){if(!n[a]){if(!t[a]){var l="function"==typeof require&&require;if(!c&&l)return l(a,!0);if(r)return r(a,!0);var s=new Error("Cannot find module '"+a+"'");throw s.code="MODULE_NOT_FOUND",s}var u=n[a]={exports:{}};t[a][0].call(u.exports,function(e){var n=t[a][1][e];return o(n?n:e)},u,u.exports,e,t,n,i)}return n[a].exports}for(var r="function"==typeof require&&require,a=0;a0&&void 0!==arguments[0]?arguments[0]:{};this.action=t.action,this.emitter=t.emitter,this.target=t.target,this.text=t.text,this.trigger=t.trigger,this.selectedText=""}},{key:"initSelection",value:function e(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"selectFake",value:function e(){var t=this,n="rtl"==document.documentElement.getAttribute("dir");this.removeFake(),this.fakeHandlerCallback=function(){return t.removeFake()},this.fakeHandler=document.body.addEventListener("click",this.fakeHandlerCallback)||!0,this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[n?"right":"left"]="-9999px";var i=window.pageYOffset||document.documentElement.scrollTop;this.fakeElem.addEventListener("focus",window.scrollTo(0,i)),this.fakeElem.style.top=i+"px",this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,document.body.appendChild(this.fakeElem),this.selectedText=(0,o.default)(this.fakeElem),this.copyText()}},{key:"removeFake",value:function e(){this.fakeHandler&&(document.body.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(document.body.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function e(){this.selectedText=(0,o.default)(this.target),this.copyText()}},{key:"copyText",value:function e(){var t=void 0;try{t=document.execCommand(this.action)}catch(e){t=!1}this.handleResult(t)}},{key:"handleResult",value:function e(t){this.emitter.emit(t?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function e(){this.target&&this.target.blur(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function e(){this.removeFake()}},{key:"action",set:function e(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"copy";if(this._action=t,"copy"!==this._action&&"cut"!==this._action)throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function e(){return this._action}},{key:"target",set:function e(t){if(void 0!==t){if(!t||"object"!==("undefined"==typeof t?"undefined":r(t))||1!==t.nodeType)throw new Error('Invalid "target" value, use a valid Element');if("copy"===this.action&&t.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if("cut"===this.action&&(t.hasAttribute("readonly")||t.hasAttribute("disabled")))throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');this._target=t}},get:function e(){return this._target}}]),e}();e.exports=c})},{select:5}],8:[function(t,n,i){!function(o,r){if("function"==typeof e&&e.amd)e(["module","./clipboard-action","tiny-emitter","good-listener"],r);else if("undefined"!=typeof i)r(n,t("./clipboard-action"),t("tiny-emitter"),t("good-listener"));else{var a={exports:{}};r(a,o.clipboardAction,o.tinyEmitter,o.goodListener),o.clipboard=a.exports}}(this,function(e,t,n,i){"use strict";function o(e){return e&&e.__esModule?e:{default:e}}function r(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function a(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t}function c(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)}function l(e,t){var n="data-clipboard-"+e;if(t.hasAttribute(n))return t.getAttribute(n)}var s=o(t),u=o(n),f=o(i),d=function(){function e(e,t){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action="function"==typeof t.action?t.action:this.defaultAction,this.target="function"==typeof t.target?t.target:this.defaultTarget,this.text="function"==typeof t.text?t.text:this.defaultText}},{key:"listenClick",value:function e(t){var n=this;this.listener=(0,f.default)(t,"click",function(e){return n.onClick(e)})}},{key:"onClick",value:function e(t){var n=t.delegateTarget||t.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new s.default({action:this.action(n),target:this.target(n),text:this.text(n),trigger:n,emitter:this})}},{key:"defaultAction",value:function e(t){return l("action",t)}},{key:"defaultTarget",value:function e(t){var n=l("target",t);if(n)return document.querySelector(n)}},{key:"defaultText",value:function e(t){return l("text",t)}},{key:"destroy",value:function e(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}]),t}(u.default);e.exports=h})},{"./clipboard-action":7,"good-listener":4,"tiny-emitter":6}]},{},[8])(8)}); \ No newline at end of file diff --git a/docs/input/blog/new-release-0.1.0.md b/docs/input/blog/new-release-0.1.0.md new file mode 100644 index 0000000..ba98045 --- /dev/null +++ b/docs/input/blog/new-release-0.1.0.md @@ -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 diff --git a/docs/input/blog/new-release-0.2.0.md b/docs/input/blog/new-release-0.2.0.md new file mode 100644 index 0000000..34bbe60 --- /dev/null +++ b/docs/input/blog/new-release-0.2.0.md @@ -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 + diff --git a/docs/input/docs/building/index.cshtml b/docs/input/docs/building/index.cshtml new file mode 100644 index 0000000..1d03f26 --- /dev/null +++ b/docs/input/docs/building/index.cshtml @@ -0,0 +1,7 @@ +--- +Order: 3 +Description: How to build the Cake.Transifex library +--- +

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

+ +@Html.Partial("_ChildPages") diff --git a/docs/input/docs/building/linux.md b/docs/input/docs/building/linux.md new file mode 100644 index 0000000..54d7d75 --- /dev/null +++ b/docs/input/docs/building/linux.md @@ -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)* diff --git a/docs/input/docs/building/macos.md b/docs/input/docs/building/macos.md new file mode 100644 index 0000000..604e2a4 --- /dev/null +++ b/docs/input/docs/building/macos.md @@ -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. diff --git a/docs/input/docs/building/windows.md b/docs/input/docs/building/windows.md new file mode 100644 index 0000000..ed49bac --- /dev/null +++ b/docs/input/docs/building/windows.md @@ -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`. diff --git a/docs/input/docs/index.cshtml b/docs/input/docs/index.cshtml new file mode 100644 index 0000000..6a6cb3c --- /dev/null +++ b/docs/input/docs/index.cshtml @@ -0,0 +1,19 @@ +--- +Title: Documentation +--- +

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

+ +

We need your help to improve the documentation for Cake.Transifex, 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) +} diff --git a/docs/input/docs/usage/contributing.md b/docs/input/docs/usage/contributing.md new file mode 100644 index 0000000..5c1c40d --- /dev/null +++ b/docs/input/docs/usage/contributing.md @@ -0,0 +1,33 @@ +--- +Order: 20 +Title: Contributing +--- + +This is very much an active project so any and all contributions are welcome, even just finding issues! + +## Reporting Issues + +All issues should be tracked at [GitHub](https://github.com/cake-contrib/Cake.Transifex), +with enough information to reproduce the issue. + +## Code Contributions + +This repository is based around the Git Flow workflow, using feature/hotfix/bugfix branches and pull requests to manage incoming changes and fixes. Generally speaking you can follow a similar guidance as Cake itself (found [here](http://cakebuild.net/docs/contributing/guidelines)), which can be summarised as follows: + +- Find a change or fix you want to implement +- Fork the repo +- Workflow for new features + - Create a new branch named `feature/` and make your changes + - Open a PR from your feature branch against the `develop` branch (include the GitHub issue number) +- Workflow for bug fixes in the latest stable version + - Create a new branch named `hotfix/` and make your changes + - Open a PR from your hotfix branch against the `master` branch (include the GitHub issue number) + *(This will be re-targeted to a different branch when accepted)* +- Workflow for bug fixes in an unpublished version of Cake.Transifex + - Create a new branch named `bugfix/` and make your changes + - Open a PR from your bugfix branch against the `develop` branch (include the GitHub issue number) +- Success! I will provide feedback if needed, or just accept the changes directly and they should appear in the next release + +## License + +Note that this project (and all contributions) fall under the [MIT License terms](https://github.com/cake-contrib/Cake.Transifex/blob/master/LICENSE). diff --git a/docs/input/docs/usage/index.cshtml b/docs/input/docs/usage/index.cshtml new file mode 100644 index 0000000..2e641c9 --- /dev/null +++ b/docs/input/docs/usage/index.cshtml @@ -0,0 +1,7 @@ +--- +Order: 2 +Description: How to obtain, configure, and execute Cake.Incubator. +--- +

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

+ +@Html.Partial("_ChildPages") diff --git a/docs/input/docs/usage/intro.md b/docs/input/docs/usage/intro.md new file mode 100644 index 0000000..6355bcb --- /dev/null +++ b/docs/input/docs/usage/intro.md @@ -0,0 +1,26 @@ +--- +Order: 10 +Title: Introduction +Author: Kim Nordmo +--- + +# Getting Started + +This addin is designed to be used inside of cake scripts. To start using it, first you must add a cake [preprocessor directive](http://cakebuild.net/docs/fundamentals/preprocessor-directives) to your script as below. + +```cs +// latest version +#addin "Cake.Transifex" + +// or +#addin "nuget?package=Cake.Transifex" + +// for a specific version, use ?version= +#addin "Cake.Transifex?version=0.3.0" +``` + +When the cake script is run, this will download the latest version of the `Cake.Transifex` nuget package and will now be available to use inside of the script. + + +*NOTE: Remember to also install the transifex (`tx`) client on the running computer, this can be installed through +the python `pip` utility (`pip install transifex-client`).* diff --git a/docs/input/index.cshtml b/docs/input/index.cshtml new file mode 100644 index 0000000..35a248b --- /dev/null +++ b/docs/input/index.cshtml @@ -0,0 +1,26 @@ +--- +Title: Cake.Transifex +NoSidebar: true +NoContainer: false +NoGutter: false +--- + +
+

What is it?

+

+ Cake.Transifex is a addin for the Cake Build script adding support for working with the localization service Transifex. + This addin requires that the transifex client is already installed and is available as `tx`. +

+ +

Where to get it

+

+ Officially published versions are available on + + NuGet + . + While development versions is made available using the following nuget end point: + + https://www.myget.org/F/cake-contrib/api/v2 + +

+
diff --git a/docs/packages.xml b/docs/packages.xml new file mode 100644 index 0000000..6dbc928 --- /dev/null +++ b/docs/packages.xml @@ -0,0 +1,150 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file