Skip to content

Commit d83a516

Browse files
ZoldorfTheWizardZoldorfTheWizard
authored
Adds SS14 DocFX (space-wizards#7216)
1 parent 248c21e commit d83a516

12 files changed

+785
-0
lines changed

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ paket-files/
252252
# JetBrains Rider
253253
.idea/
254254
*.sln.iml
255+
.editorconfig
255256

256257
# CodeRush
257258
.cr/
@@ -295,3 +296,8 @@ desktop.ini
295296

296297
# Images generated using the MapRenderer
297298
Resources/MapImages
299+
300+
## Docfx stuff
301+
/Content.Docfx/api/
302+
/Content.Docfx/*site
303+

‎Content.Docfx/articles/example-article.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Add your introductions here!

‎Content.Docfx/articles/toc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: Example-article
2+
href: example-article.md

‎Content.Docfx/docfx.json

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
{
2+
"metadata": [
3+
{
4+
"src":
5+
[
6+
{
7+
"files": [
8+
"**.csproj"
9+
],
10+
"exclude": [
11+
"**/bin/**",
12+
"**/obj/**",
13+
"_site/**",
14+
"**.xaml"
15+
],
16+
"src": "../Content.Client"
17+
}
18+
],
19+
"disableGitFeatures": false,
20+
"disableDefaultFilter": false,
21+
"dest": "api/Content.Client"
22+
},
23+
{
24+
"src":
25+
[
26+
{
27+
"files": [
28+
"**.csproj"
29+
],
30+
"exclude": [
31+
"**/bin/**",
32+
"**/obj/**",
33+
"_site/**",
34+
"**.xaml"
35+
],
36+
"src": "../Content.Server"
37+
}
38+
],
39+
"disableGitFeatures": false,
40+
"disableDefaultFilter": false,
41+
"dest": "api/Content.Server"
42+
},
43+
{
44+
"src":
45+
[
46+
{
47+
"files": [
48+
"**.csproj"
49+
],
50+
"exclude": [
51+
"**/bin/**",
52+
"**/obj/**",
53+
"_site/**",
54+
"**.xaml"
55+
],
56+
"src": "../Content.Shared"
57+
}
58+
],
59+
"disableGitFeatures": false,
60+
"disableDefaultFilter": false,
61+
"dest": "api/Content.Shared"
62+
},
63+
{
64+
"src":
65+
[
66+
{
67+
"files": [
68+
"**.csproj"
69+
],
70+
"exclude": [
71+
"**/bin/**",
72+
"**/obj/**",
73+
"_site/**",
74+
"**.xaml"
75+
],
76+
"src": "../Content.Tests"
77+
}
78+
],
79+
"disableGitFeatures": false,
80+
"disableDefaultFilter": false,
81+
"dest": "api/Content.Tests"
82+
}
83+
],
84+
"build": {
85+
"content": [
86+
{
87+
"files": [
88+
"api/**/**.yml"
89+
]
90+
},
91+
{
92+
"files": [
93+
"articles/**.md",
94+
"articles/**/toc.yml",
95+
"toc.yml",
96+
"*.md"
97+
]
98+
}
99+
],
100+
"resource": [
101+
{
102+
"files": [
103+
"images/**",
104+
"favicon.ico",
105+
"icon.svg"
106+
]
107+
}
108+
],
109+
"overwrite": [
110+
{
111+
"files": [
112+
"apidoc/**.md"
113+
],
114+
"exclude": [
115+
"obj/**",
116+
"_site/**"
117+
]
118+
}
119+
],
120+
"dest": "_content-site",
121+
"globalMetadataFiles": [],
122+
"fileMetadataFiles": [],
123+
"template": [
124+
"default",
125+
"templates/darkfx"
126+
],
127+
"postProcessors": [],
128+
"markdownEngineName": "markdig",
129+
"noLangKeyword": false,
130+
"keepFileLink": false,
131+
"cleanupCacheHistory": false,
132+
"disableGitFeatures": false
133+
}
134+
}

‎Content.Docfx/index.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Space Station 14 DocFX
2+
![](https://i.imgur.com/0h6VoRZ.png)
3+
4+
## Welcome to the Space Station 14 DocFX instance.
5+
### Click one of the tabs above to see documentation for that particular project/namespace
6+
7+
## Links
8+
9+
[Website](https://spacestation14.io/) | [Discord](https://discord.gg/t2jac3p) | [Forum](https://forum.spacestation14.io/) | [Steam](https://store.steampowered.com/app/1255460/Space_Station_14/) | [Standalone Download](https://spacestation14.io/about/nightlies/)

‎Content.Docfx/templates/darkfx/LICENSE.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Steffen Wilke
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Content.Docfx/templates/darkfx/partials/affix.tmpl.partial

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
<div class="hidden-sm col-md-2" role="complementary">
4+
<div class="sideaffix">
5+
{{^_disableContribution}}
6+
<div class="contribution">
7+
<ul class="nav">
8+
{{#docurl}}
9+
<li>
10+
<a href="{{docurl}}" class="contribution-link">{{__global.improveThisDoc}}</a>
11+
</li>
12+
{{/docurl}}
13+
{{#sourceurl}}
14+
<li>
15+
<a href="{{sourceurl}}" class="contribution-link">{{__global.viewSource}}</a>
16+
</li>
17+
{{/sourceurl}}
18+
</ul>
19+
</div>
20+
{{/_disableContribution}}
21+
<div class="toggle-mode">
22+
<div class="icon">
23+
<i aria-hidden="true">☀</i>
24+
</div>
25+
<label class="switch">
26+
<input type="checkbox" id="switch-style">
27+
<span class="slider round"></span>
28+
</label>
29+
<div class="icon">
30+
<i aria-hidden="true">☾</i>
31+
</div>
32+
</div>
33+
34+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
35+
<h5>{{__global.inThisArticle}}</h5>
36+
<div></div>
37+
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
38+
</nav>
39+
</div>
40+
</div>

‎Content.Docfx/templates/darkfx/partials/footer.tmpl.partial

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
<footer>
4+
<div class="grad-bottom"></div>
5+
<div class="footer">
6+
<div class="container">
7+
<span class="pull-right">
8+
<a href="#top">Back to top</a>
9+
</span>
10+
<div class="pull-left">
11+
{{{_appFooter}}}
12+
{{^_appFooter}}<span>Generated by <strong>DocFX</strong></span>{{/_appFooter}}
13+
</div>
14+
<div class="toggle-mode pull-right visible-sm visible-xs">
15+
<div class="icon">
16+
<i aria-hidden="true">☀</i>
17+
</div>
18+
<label class="switch">
19+
<input type="checkbox" id="switch-style-m">
20+
<span class="slider round"></span>
21+
</label>
22+
<div class="icon">
23+
<i aria-hidden="true">☾</i>
24+
</div>
25+
</div>
26+
</div>
27+
</div>
28+
<script type="text/javascript" src="{{_rel}}styles/toggle-theme.js"></script>
29+
</footer>

‎Content.Docfx/templates/darkfx/partials/head.tmpl.partial

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{{!Copyright (c) Oscar Vasquez. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
6+
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
7+
<meta name="viewport" content="width=device-width">
8+
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
9+
<meta name="generator" content="docfx {{_docfxVersion}}">
10+
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
11+
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
12+
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
13+
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
14+
<link rel="stylesheet" href="{{_rel}}styles/main.css">
15+
<meta property="docfx:navrel" content="{{_navRel}}">
16+
<meta property="docfx:tocrel" content="{{_tocRel}}">
17+
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
18+
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
19+
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}}
20+
</head>

0 commit comments

Comments
 (0)