-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* [#15] Add usage examples to code * [#15] Add examples to documentation * [#15] Add Contributing docs page
- Loading branch information
1 parent
3b4cfb5
commit 27dd4c2
Showing
36 changed files
with
1,587 additions
and
288 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
<div class="github-button"> | ||
<a href="https://github.com/michalkowal/Cake.MkDocs"><i class="fa fa-github"></i> GitHub</a> | ||
</div> | ||
<script> | ||
((window.gitter = {}).chat = {}).options = { | ||
room: 'cake-contrib/Lobby' | ||
}; | ||
</script> | ||
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script> | ||
|
||
<script type="text/javascript" src="@Context.GetLink("/assets/js/anchor.min.js")"></script> | ||
<script type="text/javascript" src="@Context.GetLink("/assets/js/clipboard.min.js")"></script> | ||
<script type="text/javascript"> | ||
anchors.options.placement = 'left'; | ||
anchors.add('#content > h1,h2,h3,h4'); | ||
var snippets = document.querySelectorAll("pre > code"); | ||
[].forEach.call(snippets, function(snippet) { | ||
snippet.insertAdjacentHTML("beforebegin", "<button class='btn-copy' data-clipboard-snippet><img class='clippy' width=13 src='@Context.GetLink("/assets/images/clippy.svg")' alt='Copy to clipboard'></button>"); | ||
}); | ||
var clipboardSnippets = new Clipboard('[data-clipboard-snippet]', { | ||
target: function(trigger) { | ||
return trigger.nextElementSibling; | ||
} | ||
}); | ||
clipboardSnippets.on('success', function(e) { | ||
e.clearSelection(); | ||
showTooltip(e.trigger, "Copied!"); | ||
}); | ||
clipboardSnippets.on('error', function(e) { | ||
showTooltip(e.trigger, fallbackMessage(e.action)); | ||
}); | ||
var btns = document.querySelectorAll('.btn-copy'); | ||
for (var i = 0; i < btns.length; i++) { | ||
btns[i].addEventListener('mouseleave', function(e) { | ||
e.currentTarget.setAttribute('class', 'btn-copy'); | ||
e.currentTarget.removeAttribute('aria-label'); | ||
}); | ||
} | ||
function showTooltip(elem, msg) { | ||
elem.setAttribute('class', 'btn-copy tooltipped tooltipped-s'); | ||
elem.setAttribute('aria-label', msg); | ||
} | ||
function fallbackMessage(action) { | ||
var actionMsg = ''; | ||
var actionKey = (action === 'cut' ? 'X' : 'C'); | ||
if (/iPhone|iPad/i.test(navigator.userAgent)) { | ||
actionMsg = 'No support :('; | ||
} else if (/Mac/i.test(navigator.userAgent)) { | ||
actionMsg = 'Press ⌘-' + actionKey + ' to ' + action; | ||
} else { | ||
actionMsg = 'Press Ctrl-' + actionKey + ' to ' + action; | ||
} | ||
return actionMsg; | ||
} | ||
</script> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
/* 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; | ||
} | ||
.tooltipped { | ||
position: relative | ||
} | ||
.tooltipped:after { | ||
position: absolute; | ||
z-index: 1000000; | ||
display: none; | ||
padding: 5px 8px; | ||
font: normal normal 11px/1.5 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol"; | ||
color: #fff; | ||
text-align: center; | ||
text-decoration: none; | ||
text-shadow: none; | ||
text-transform: none; | ||
letter-spacing: normal; | ||
word-wrap: break-word; | ||
white-space: pre; | ||
pointer-events: none; | ||
content: attr(aria-label); | ||
background: rgba(0, 0, 0, 0.8); | ||
border-radius: 3px; | ||
-webkit-font-smoothing: subpixel-antialiased | ||
} | ||
.tooltipped:before { | ||
position: absolute; | ||
z-index: 1000001; | ||
display: none; | ||
width: 0; | ||
height: 0; | ||
color: rgba(0, 0, 0, 0.8); | ||
pointer-events: none; | ||
content: ""; | ||
border: 5px solid transparent | ||
} | ||
.tooltipped:hover:before, .tooltipped:hover:after, .tooltipped:active:before, .tooltipped:active:after, .tooltipped:focus:before, .tooltipped:focus:after { | ||
display: inline-block; | ||
text-decoration: none | ||
} | ||
.tooltipped-s:after, .tooltipped-se:after, .tooltipped-sw:after { | ||
top: 100%; | ||
right: 50%; | ||
margin-top: 5px | ||
} | ||
.tooltipped-s:before, .tooltipped-se:before, .tooltipped-sw:before { | ||
top: auto; | ||
right: 50%; | ||
bottom: -5px; | ||
margin-right: -5px; | ||
border-bottom-color: rgba(0, 0, 0, 0.8) | ||
} | ||
|
||
@font-family-sans-serif: "Roboto", Helvetica, Arial, sans-serif; | ||
|
||
/* For Gitter and GitHub */ | ||
.bottom-footer { | ||
margin-bottom: 40px !important; // Make room for Gitter and GitHub buttons | ||
} | ||
|
||
.gitter-open-chat-button { | ||
background-color: #3c8dbc; | ||
font-family: @font-family-sans-serif; | ||
letter-spacing: normal; | ||
right: 90px; | ||
} | ||
|
||
.gitter-open-chat-button:focus, .gitter-open-chat-button:hover, | ||
.github-button:focus, .github-button:hover, | ||
{ | ||
background-color: #4EABDD; | ||
color: #fff; | ||
} | ||
|
||
.gitter-chat-embed { | ||
top: 49px; | ||
border-top: 1px solid #000; | ||
z-index: 10000; | ||
} | ||
|
||
.github-button { | ||
z-index: 100; | ||
position: fixed; | ||
bottom: 0px; | ||
right: 240px; | ||
padding: 1em 3em; | ||
background-color: #367fa9; | ||
border: 0; | ||
border-top-left-radius: 0.5em; | ||
border-top-right-radius: 0.5em; | ||
font-family: sans-serif; | ||
font-size: 9pt; | ||
text-transform: uppercase; | ||
text-align: center; | ||
text-decoration: none; | ||
cursor: pointer; | ||
cursor: hand; | ||
-webkit-transition: all .3s ease; | ||
transition: all .3s ease; | ||
color: #fff; | ||
a, a:active, a:hover, a:focus { | ||
color: #fff; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
Order: 1 | ||
--- | ||
|
||
# Build scripts | ||
|
||
To build this package we are using Cake. | ||
|
||
On Windows PowerShell run: | ||
|
||
```powershell | ||
./build | ||
``` | ||
|
||
On OSX/Linux run: | ||
|
||
```bash | ||
./build.sh | ||
``` | ||
|
||
# Important developer tasks | ||
|
||
## Default task | ||
|
||
Clean, DotNetCore build, unit tests, code coverage, code analyze, NuGet package, create release notes. | ||
|
||
```powershell | ||
./build | ||
``` | ||
```powershell | ||
./build -Target Default | ||
``` | ||
|
||
## AppVeyor task | ||
|
||
The same as Default and: | ||
Publish documentation, upload code coverage, publish release note, publish NuGet, upload build artifacts. | ||
|
||
```powershell | ||
./build -Target Appveyor | ||
``` | ||
|
||
## Preview task | ||
|
||
```powershell | ||
./build -Target Preview | ||
``` | ||
|
||
Generate documentation and host documentation locally for development. | ||
More about [Preview](https://cake-contrib.github.io/Cake.Recipe/docs/usage/previewing-documentation) | ||
and [Docs publishing](https://cake-contrib.github.io/Cake.Recipe/docs/usage/publishing-documentation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
Order: 20 | ||
Description: How to build, and run Cake.MkDocs. | ||
--- | ||
<p>@Html.Raw(Model.String(DocsKeys.Description))</p> | ||
|
||
@Html.Partial("_ChildPages") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
Order: 2 | ||
--- | ||
|
||
# Running integration tests | ||
|
||
Addin contains set of integration tests written as additional Cake files. | ||
**test.cake** - is an entry point for integration tests. Installs Cake.MkDocs nuget package from BuildArtifacts directory and use him in all tests. | ||
**setup.cake** - his responsibility is launch integration tests in sandbox. | ||
|
||
## Run-Integration-Tests task | ||
|
||
```powershell | ||
./build -Target Run-Integration-Tests | ||
``` | ||
|
||
Task first of all execute *Default* target to build all artifacts. | ||
After all use BuildArtifacts and runs integration tests (**test.cake**). | ||
|
||
## Run-Integration-Tests-Standalone task | ||
|
||
```powershell | ||
./build -Target Run-Integration-Tests-Standalone | ||
``` | ||
|
||
Task use BuildArtifacts and runs integration tests without build - use for integration tests development. | ||
This task is also run additionally after target task, when target is different than *Run-Integration-Tests* (e.g. *Default*, *Appveyor*) and BuildParameters.ShouldRunIntegrationTests flag is true. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
Order: 4 | ||
--- | ||
|
||
# MkDocs build command | ||
|
||
## MkDocs project in working directory | ||
|
||
Build MkDocs project: | ||
|
||
```c# | ||
MkDocsBuild(); | ||
``` | ||
|
||
With settings: | ||
|
||
```c# | ||
MkDocsBuild(new MkDocsBuildSettings() | ||
{ | ||
Dirty = true, | ||
Theme = MkDocsTheme.ReadTheDocs | ||
}); | ||
``` | ||
|
||
## MkDocs project in different directory | ||
|
||
Build MkDocs in provided directory: | ||
|
||
```c# | ||
MkDocsBuild("./docs-project"); | ||
``` | ||
```c# | ||
MkDocsBuild(new DirectoryPath("./docs-project")); | ||
``` | ||
|
||
With settings: | ||
|
||
```c# | ||
MkDocsBuild"./docs-project", new MkDocsBuildSettings() | ||
{ | ||
Dirty = true, | ||
Theme = MkDocsTheme.ReadTheDocs | ||
}); | ||
``` | ||
```c# | ||
MkDocsBuild(new DirectoryPath("./docs-project") ,new MkDocsBuildSettings() | ||
{ | ||
Dirty = true, | ||
Theme = MkDocsTheme.ReadTheDocs | ||
}); | ||
``` |
Oops, something went wrong.