-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.html
150 lines (137 loc) · 6.5 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Plugin SDK DocFX Project | HomeSeer PluginSdk Docs </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Plugin SDK DocFX Project | HomeSeer PluginSdk Docs ">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="images/favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<link rel="stylesheet" href="styles/perfect-scrollbar.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="images/HomeSeer_Full_Logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container-fluid body-content hide-when-search">
<div class="article row grid">
<div class="col-md-1"></div>
<div class="col-md-8 card">
<article class="content wrap" id="_content" data-uid="">
<h1 id="plugin-sdk-docfx-project">Plugin SDK DocFX Project</h1>
<p><img src="https://img.shields.io/badge/PluginSdk-v1.4.4.0-blue" alt="Latest Release Version - PluginSDK"> <a href="https://github.com/dotnet/docfx/releases/tag/v2.59.4"><img src="https://img.shields.io/badge/DocFX-v2.59.4-green" alt="Using this DocFX version"></a></p>
<p>This project is used to build the API Reference for the Plugin SDK.</p>
<h2 id="getting-started">Getting Started</h2>
<p>Chocolatey and DocFX are required to build this project.</p>
<h3 id="install-chocolatey">Install Chocolatey</h3>
<p>First, you will need to make sure you <a href="https://docs.chocolatey.org/en-us/choco/setup">install chocolatey</a>.
This is used to install and manage <a href="https://dotnet.github.io/docfx/index.html">DocFX</a>.</p>
<h3 id="install-docfx">Install DocFX</h3>
<p>Next, install <a href="https://dotnet.github.io/docfx/index.html">DocFX</a> using chocolatey by running <code>choco install docfx -y</code>
from a command line terminal.</p>
<h3 id="clone-plugin-sdk-source">Clone Plugin SDK Source</h3>
<p>The Plugin SDK source must be located in a directory called "src" in the same location as the this project.
Pull the latest Plugin SDK source from <a href="https://github.com/HomeSeer/Plugin-SDK">GitHub</a> into this directory.</p>
<h2 id="build-instructions">Build Instructions</h2>
<p>Once everything is in the right place, you can build the documentation by building the Plugin SDK using the Docs build configurations
and then running the following commands:</p>
<ul>
<li><code>docfx metadata -f</code></li>
<li><code>docfx build -f</code></li>
<li><code>docfx metadata -f</code></li>
<li><code>docfx build -f</code></li>
</ul>
<p><em>Yes. These commands should be run twice.</em>
Then you can test it by running <code>docfx --serve</code></p>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix" id="ps-sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
HomeSeer Technologies
</div>
</div>
</footer>
</div>
<!-- Mermaid -->
<!-- Lets you create diagrams and visualizations using text and code. -->
<!-- https://mermaid-js.github.io/mermaid/ -->
<!-- Required styles -->
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
<!-- Load v9.1.3 of Mermaid -->
<!-- Hash obtained via https://www.srihash.org/ -->
<script type="text/javascript" src="https://unpkg.com/mermaid@9.1.3/dist/mermaid.min.js" integrity="sha384-LnGjpNDrP4cp7MIk4CpRa/lPNclrf839ryYVFx1T1mPSV3RGAZ7nlBa7pqcyGY/K" crossorigin="anonymous"></script>
<!-- Initialize Mermaid -->
<script>
mermaid.initialize({
startOnLoad: false
});
mermaid.init(undefined, ".lang-mermaid");
</script> </body>
</html>