Skip to content
This repository has been archived by the owner on Mar 7, 2020. It is now read-only.

chore: adjusting the links for the docu edits to point to the main repo #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/args.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/args.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Command line arguments</h1></header><article><div><span><p><code>just-task</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>just-task</code> exposes these via <code>this.argv</code> inside a task function.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/args.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Command line arguments</h1></header><article><div><span><p><code>just-task</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>just-task</code> exposes these via <code>this.argv</code> inside a task function.</p>
<h2><a class="anchor" aria-hidden="true" id="reading-arguments"></a><a href="#reading-arguments" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Reading arguments</h2>
<p>To read the arguments passed in from command line, use the <code>this.argv</code> object provided by <code>yargs</code>.</p>
<pre><code class="hljs css language-js">task(<span class="hljs-string">'pillageMeArgs'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/args/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/args.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Command line arguments</h1></header><article><div><span><p><code>just-task</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>just-task</code> exposes these via <code>this.argv</code> inside a task function.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/args.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Command line arguments</h1></header><article><div><span><p><code>just-task</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>just-task</code> exposes these via <code>this.argv</code> inside a task function.</p>
<h2><a class="anchor" aria-hidden="true" id="reading-arguments"></a><a href="#reading-arguments" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Reading arguments</h2>
<p>To read the arguments passed in from command line, use the <code>this.argv</code> object provided by <code>yargs</code>.</p>
<pre><code class="hljs css language-js">task(<span class="hljs-string">'pillageMeArgs'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/composition.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/composition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Composition of tasks</h1></header><article><div><span><p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>just-task</code> is made. It simplifies the composition of tasks.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/composition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Composition of tasks</h1></header><article><div><span><p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>just-task</code> is made. It simplifies the composition of tasks.</p>
<h2><a class="anchor" aria-hidden="true" id="running-tasks-in-a-series"></a><a href="#running-tasks-in-a-series" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Running tasks in a series</h2>
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> { task, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'just-task'</span>);

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/composition/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/composition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Composition of tasks</h1></header><article><div><span><p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>just-task</code> is made. It simplifies the composition of tasks.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/composition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Composition of tasks</h1></header><article><div><span><p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>just-task</code> is made. It simplifies the composition of tasks.</p>
<h2><a class="anchor" aria-hidden="true" id="running-tasks-in-a-series"></a><a href="#running-tasks-in-a-series" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Running tasks in a series</h2>
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> { task, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'just-task'</span>);

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/condition.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/condition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Controlling Task Flow with Conditionals</h1></header><article><div><span><p>Sometimes a <code>just-task.js</code> would include tasks that are skipped depending on the arguments that are given. Use a <code>condition()</code> function to decide to run a task or to skip it.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/condition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Controlling Task Flow with Conditionals</h1></header><article><div><span><p>Sometimes a <code>just-task.js</code> would include tasks that are skipped depending on the arguments that are given. Use a <code>condition()</code> function to decide to run a task or to skip it.</p>
<h2><a class="anchor" aria-hidden="true" id="running-tasks-in-a-series"></a><a href="#running-tasks-in-a-series" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Running tasks in a series</h2>
<p>As we have seen, tasks can be run in a series.</p>
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> { task, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'just-task'</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/condition/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/condition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Controlling Task Flow with Conditionals</h1></header><article><div><span><p>Sometimes a <code>just-task.js</code> would include tasks that are skipped depending on the arguments that are given. Use a <code>condition()</code> function to decide to run a task or to skip it.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/condition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Controlling Task Flow with Conditionals</h1></header><article><div><span><p>Sometimes a <code>just-task.js</code> would include tasks that are skipped depending on the arguments that are given. Use a <code>condition()</code> function to decide to run a task or to skip it.</p>
<h2><a class="anchor" aria-hidden="true" id="running-tasks-in-a-series"></a><a href="#running-tasks-in-a-series" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Running tasks in a series</h2>
<p>As we have seen, tasks can be run in a series.</p>
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> { task, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'just-task'</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/doc-start.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/doc-start.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Getting Started with Just ____</h1></header><article><div><span><p><code>Just</code> is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. We encourage developers to make <code>just</code> available locally instead of installing <code>just</code> as a global tool.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/doc-start.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Getting Started with Just ____</h1></header><article><div><span><p><code>Just</code> is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. We encourage developers to make <code>just</code> available locally instead of installing <code>just</code> as a global tool.</p>
<pre><code class="hljs css language-sh">npm i -D just-task
</code></pre>
<p>Place some task definitions inside <code>just-task.js</code> in your root folder (next to package.json):</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/doc-start/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/doc-start.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Getting Started with Just ____</h1></header><article><div><span><p><code>Just</code> is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. We encourage developers to make <code>just</code> available locally instead of installing <code>just</code> as a global tool.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/doc-start.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Getting Started with Just ____</h1></header><article><div><span><p><code>Just</code> is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. We encourage developers to make <code>just</code> available locally instead of installing <code>just</code> as a global tool.</p>
<pre><code class="hljs css language-sh">npm i -D just-task
</code></pre>
<p>Place some task definitions inside <code>just-task.js</code> in your root folder (next to package.json):</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/logging.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/just-task/tree/master/packages/documentation/docs/logging.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Logging</h1></header><article><div><span><p><code>just-task</code> is simple, but it is opinionated. One of the built-in capabilities of <code>just-task</code> is logging. We feel that this is an important enough of a feature to be available by the library.</p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/just/tree/master/packages/documentation/docs/logging.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Logging</h1></header><article><div><span><p><code>just-task</code> is simple, but it is opinionated. One of the built-in capabilities of <code>just-task</code> is logging. We feel that this is an important enough of a feature to be available by the library.</p>
<p>Typically, logging tasks look like the following:</p>
<p><img src="/just-task/docs/assets/typical.png" alt=""></p>
<h2><a class="anchor" aria-hidden="true" id="usage"></a><a href="#usage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage</h2>
Expand Down
Loading