Skip to content

Commit 30e6444

Browse files
ethanhannethanhann
committed
Add basic docs site
1 parent 625c56c commit 30e6444

37 files changed

+2347
-0
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,4 +188,5 @@ FakesAssemblies/
188188
*.nupkg
189189

190190
.DS_Store
191+
.idea/
191192

‎docs-src/css/style.css‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.navbar-default {
2+
background: #2f2f2f;
3+
}
4+
5+
.navbar-default .navbar-nav > .active > a,
6+
.navbar-default .navbar-nav > .active > a:hover,
7+
.navbar-default .navbar-nav > .active > a:focus {
8+
background-color: #0f0f0f;
9+
}
10+
11+
.navbar-default .navbar-nav > li > a:hover,
12+
.navbar-default .navbar-nav > li > a:focus {
13+
background-color: #0f0f0f;
14+
}
15+
16+
a,
17+
a:hover,
18+
a:focus {
19+
color: #2200CC;
20+
}
21+

‎docs-src/img/inengine-header.png‎

10 KB
Loading

‎docs-src/img/inengine-logo-32-alt.png‎

746 Bytes
Loading

‎docs-src/index.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# What is this?
2+
3+
InEngine.NET is a background commands processing server.
4+
It allows commands to be queued, scheduled, and ran directly.
5+
6+
## Install
7+
8+
First, install the InEngine.Core package into your own Visual Studio project.
9+
10+
**Package Manager**
11+
```bash
12+
Install-Package InEngine.Core
13+
```
14+
15+
**Nuget CLI**
16+
```bash
17+
nuget install InEgine.Core
18+
```
19+
20+
**.NET CLI**
21+
```bash
22+
dotnet add package InEngine.Core
23+
```
24+
25+
**Paket CLI**
26+
```bash
27+
paket add InEngine.Core
28+
```
29+
30+
Second, download the CLI and/or the Scheduler from a release that matches the version of the InEngine.Core package you included.
31+
32+
Releases are found on GitHub: https://github.com/InEngine-NET/InEngine.NET/releases
33+
34+
## Create a Command
35+
36+
Add a class that implements **InEngine.Core.ICommand** or extends **InEngine.Core.AbstractCommand**.
37+
38+
```c#
39+
using InEngine.Core;
40+
41+
namespace MyCommands
42+
{
43+
public class MyCommand : ICommand
44+
{
45+
public CommandResult Run()
46+
{
47+
return new CommandResult(true);
48+
}
49+
}
50+
}
51+
```
52+
53+
The **AbstractCommand** class adds extra functionality, like a logger, a progress bar, and the ability to schedule the command using the scheduler.
54+
Minimally, the Run method should be overridden.
55+
56+
57+
```c#
58+
using InEngine.Core;
59+
60+
namespace MyCommands
61+
{
62+
public class MyCommand : AbstractCommand
63+
{
64+
public override CommandResult Run()
65+
{
66+
return new CommandResult(true);
67+
}
68+
}
69+
}
70+
```
71+
72+
73+
74+
75+
76+

‎docs/404.html‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
8+
<meta name="author" content="Ethan Hann">
9+
10+
<link rel="shortcut icon" href="/img/favicon.ico">
11+
<title>InEngine.NET</title>
12+
<link href="/css/bootstrap-custom.min.css" rel="stylesheet">
13+
<link href="/css/font-awesome-4.5.0.css" rel="stylesheet">
14+
<link href="/css/base.css" rel="stylesheet">
15+
<link rel="stylesheet" href="/css/highlight.css">
16+
<link href="/css/style.css" rel="stylesheet">
17+
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
18+
<!--[if lt IE 9]>
19+
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
20+
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
21+
<![endif]-->
22+
23+
<script src="/js/jquery-1.10.2.min.js"></script>
24+
<script src="/js/bootstrap-3.0.3.min.js"></script>
25+
<script src="/js/highlight.pack.js"></script>
26+
</head>
27+
28+
<body>
29+
30+
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
31+
<div class="container">
32+
33+
<!-- Collapsed navigation -->
34+
<div class="navbar-header">
35+
<!-- Expander button -->
36+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
37+
<span class="sr-only">Toggle navigation</span>
38+
<span class="icon-bar"></span>
39+
<span class="icon-bar"></span>
40+
<span class="icon-bar"></span>
41+
</button>
42+
<a class="navbar-brand" href="/">InEngine.NET</a>
43+
</div>
44+
45+
<!-- Expanded navigation -->
46+
<div class="navbar-collapse collapse">
47+
48+
<ul class="nav navbar-nav navbar-right">
49+
<li>
50+
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
51+
<i class="fa fa-search"></i> Search
52+
</a>
53+
</li>
54+
<li>
55+
<a href="https://github.com/InEngine-NET/InEngine.NET">
56+
<i class="fa fa-github"></i>GitHub
57+
</a>
58+
</li>
59+
</ul>
60+
</div>
61+
</div>
62+
</div>
63+
64+
<div class="container">
65+
66+
<div class="row-fluid">
67+
<div id="main-content" class="span12">
68+
<h1 id="404-page-not-found" style="text-align: center">404</h1>
69+
<p style="text-align: center"><strong>Page not found</strong></p>
70+
</div>
71+
</div>
72+
73+
74+
</div>
75+
76+
<footer class="col-md-12">
77+
<hr>
78+
<p>© 2017 - Ethan Hann</p>
79+
<p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p>
80+
</footer>
81+
<script>var base_url = '';</script>
82+
<script data-main="/mkdocs/js/search.js" src="/mkdocs/js/require.js"></script>
83+
<script src="/js/base.js"></script><div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
84+
<div class="modal-dialog">
85+
<div class="modal-content">
86+
<div class="modal-header">
87+
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
88+
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
89+
</div>
90+
<div class="modal-body">
91+
<p>
92+
From here you can search these documents. Enter
93+
your search terms below.
94+
</p>
95+
<form role="form">
96+
<div class="form-group">
97+
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
98+
</div>
99+
</form>
100+
<div id="mkdocs-search-results"></div>
101+
</div>
102+
<div class="modal-footer">
103+
</div>
104+
</div>
105+
</div>
106+
</div>
107+
108+
</body>
109+
</html>

0 commit comments

Comments
 (0)