Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
801696a
Merge pull request #2 from Chaosyr/Update-Doc-Styles
Chaosyr Nov 13, 2026
44d26d8
Update Styling
Chaosyr Nov 13, 2026
7f5dd4c
Merge pull request #3 from Chaosyr/Update-Doc-Styles
Chaosyr Nov 13, 2026
21fa0a8
Remove Styles folder from `api_wiki`
Chaosyr Nov 13, 2026
c40e02e
Fix Style and implement Community Patch and APIPatcher to Docs
Chaosyr Nov 13, 2026
4a91769
remove arbitrary exclusions for CSProj
Chaosyr Nov 13, 2026
f4511a0
Replace code block font to match
Chaosyr Nov 13, 2026
672aa9d
Update toc.yml
Chaosyr Nov 13, 2026
6136b79
Update main.css
Chaosyr Nov 13, 2026
2ef9bdf
Update main.css
Chaosyr Nov 13, 2026
0e2689f
Update main.css
Chaosyr Nov 13, 2026
0811ff6
Update main.css
Chaosyr Nov 13, 2026
ef3fe92
Update main.css
Chaosyr Nov 14, 2026
0dfd9a0
Update main.css
Chaosyr Nov 14, 2026
031cb92
Remove unneeded Partials folder carried over from DarkFX Copy
Chaosyr Nov 14, 2026
108e122
Typo fix and Prettify class.header.tmpl.partial
Chaosyr Nov 14, 2026
be2ad2a
Fix up inheritence related look
Chaosyr Nov 14, 2026
6639d2d
Update main.css
Chaosyr Nov 14, 2026
c23b620
Update main.css
Chaosyr Nov 14, 2026
df2af83
Update main.css
Chaosyr Nov 14, 2026
3204476
Update main.css
Chaosyr Nov 14, 2026
2e8709b
Update Table Implementation to DL
Chaosyr Nov 14, 2026
fd399d2
Undo Table Changes
Chaosyr Nov 14, 2026
e4db6a5
Pop off API Patcher from Docs
Chaosyr Nov 14, 2026
f90d966
Move the class header partial under api_wiki and delete inheritence t…
Chaosyr Nov 14, 2026
4773344
Experiment with disabling darkfx
Chaosyr Nov 14, 2026
00e350a
part 2
Chaosyr Nov 14, 2026
fdc8b30
fix css
Chaosyr Nov 14, 2026
436b99c
switch to min-height
Chaosyr Nov 14, 2026
89d10ea
Update Templates
Chaosyr Nov 14, 2026
5fb32a1
Some fixing
Chaosyr Nov 14, 2026
b6b4b4a
2col params, and fields table
Chaosyr Nov 14, 2026
09e32dd
CSS Cleaning and quick fix
Chaosyr Nov 14, 2026
686f246
Inline code background
Chaosyr Nov 14, 2026
d3f6c39
Underscore the page heading
Chaosyr Nov 14, 2026
71e88cf
Underscore H3 Headers
Chaosyr Nov 14, 2026
782be32
Fix borders
Chaosyr Nov 14, 2026
3e33a13
Update main.css
Chaosyr Nov 14, 2026
7aa75a5
Conditionalize H3 Headers
Chaosyr Nov 14, 2026
de098bf
Overhaul Index.md
Chaosyr Nov 14, 2026
ff0f617
Conditionalize H1
Chaosyr Nov 14, 2026
2e37ebd
Make Wiki be named Wiki
Chaosyr Nov 14, 2026
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
6 changes: 3 additions & 3 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# API Documentation
Hello, and welcome to the documentation section of the Inscryption API!
# Inscryption API Documentation
Hello, and welcome to the documentation section for the Inscryption API!

This section documents the various classes and members of the API, providing information on what they do.
This section documents the various classes and members of the Inscryption API, providing information on what they do.
5 changes: 5 additions & 0 deletions docs/community/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
4 changes: 4 additions & 0 deletions docs/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Inscryption Community Patch Documentation
Hello, and welcome to the documentation section for the Inscryption Community Patch!

This section documents the various classes and members of the Inscryption Community Patch, providing information on what they do.
33 changes: 27 additions & 6 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,22 @@
{
"src": [
{
"files": ["**/*.csproj"],
"exclude": ["**/bin/**", "**/obj/**"],
"files": ["InscryptionAPI/InscryptionAPI.csproj"],
"src": "../"
}
],
"dest": "api",
"filter": "filter.yml"
},
{
"src": [
{
"files": ["InscryptionCommunityPatch/InscryptionCommunityPatch.csproj"],
"src": "../"
}
],
"dest": "community",
"filter": "filter.yml"
}
],
"build": {
Expand All @@ -18,17 +27,30 @@
"files": ["README.md"]
},
{
"files": ["LICENSE"],
"files": ["LICENSE.md"],
"src": "../"
},
{
"files": ["images/**", "logo.svg", "favicon.ico"]
},
{
"files": ["**"],
"src": "../InscryptionAPI/Assets",
"dest": "resources/api/assets"
},
{
"files": ["**"],
"src": "../InscryptionCommunityPatch/Assets",
"dest": "resources/community/assets"
}
],
"content": [
{
"files": ["api/**.yml", "api/index.md"]
},
{
"files": ["community/**.yml", "community/index.md"]
},
{
"files": ["wiki/toc.yml", "wiki/**.md"]
},
Expand All @@ -43,7 +65,7 @@
],
"globalMetadata": {
"_appTitle": "InscryptionAPI",
"_appName": "Inscryption Modding API",
"_appName": "Inscryption Modding Wiki",
"_appLogoPath": "images/logo.svg",
"_appFaviconPath": "images/favicon.ico",
"_disableBreadcrumb": true,
Expand All @@ -65,8 +87,7 @@
"template": [
"default",
"modern",
"template/darkfx",
"template/no_inherited_members"
"template/api_wiki"
]
}
}
6 changes: 0 additions & 6 deletions docs/filter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ apiRules:
uid: System.ComponentModel.EditorBrowsableAttribute
ctorArguments:
- System.ComponentModel.EditorBrowsableState.Never
- exclude:
uidRegex: ^APIPatcher
- exclude:
uidRegex: ^APIPlugin
- exclude:
uidRegex: ^InscryptionCommunityPatch
attributeRules:
- exclude:
uidRegex: ^System\.ComponentModel\.Design$
Expand Down
278 changes: 269 additions & 9 deletions docs/index.md

Large diffs are not rendered by default.

232 changes: 232 additions & 0 deletions docs/template/api_wiki/partials/class.header.tmpl.partial
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

<h1 id="{{id}}" data-uid="{{uid}}" class="text-break">
{{>partials/title}}
{{#sourceurl}}<a class="header-action link-secondary" title="View source" href="{{sourceurl}}"><i class="bi bi-code-slash"></i></a>{{/sourceurl}}
</h1>

<div class="facts text-secondary">
<dl><dt>{{__global.namespace}}</dt><dd>{{{namespace.specName.0.value}}}</dd></dl>
{{#assemblies.0}}<dl><dt>{{__global.assembly}}</dt><dd>{{assemblies.0}}.dll</dd></dl>{{/assemblies.0}}
</div>

<div class="markdown summary">{{{summary}}}</div>
<div class="markdown conceptual">{{{conceptual}}}</div>

{{#inClass}}
<div class="inheritance">
<h5>{{__global.inheritance}}</h5>

<div class="inheritance-tree">
{{#inheritance}}
<div class="inheritance-level" style="--inheritance-level: {{index}}">
{{{specName.0.value}}}
</div>
{{/inheritance}}

<div class="inheritance-level" style="--inheritance-level: {{level}}">
<span class="xref">{{name.0.value}}</span>
</div>

{{#derivedClasses}}
<div class="inheritance-level" style="--inheritance-level: {{index}}">
{{{specName.0.value}}}
</div>
{{/derivedClasses}}
</div>
</div>
{{/inClass}}

{{#implements.0}}
<div class="implements">
<h5>{{__global.implements}}</h5>
{{/implements.0}}

{{#implements}}
<div>
{{{specName.0.value}}}
</div>
{{/implements}}

{{#implements.0}}
</div>
{{/implements.0}}

{{#syntax.content.0.value}}
<h5 id="{{id}}_syntax">
{{__global.syntax}}
</h5>

<div class="codewrapper">
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
</div>
{{/syntax.content.0.value}}

{{#syntax.parameters.0}}
<h5 class="parameters">
{{__global.parameters}}
</h5>

<table class="api-parameters">
<thead>
<tr>
<th>{{__global.name}}</th>
<th>{{__global.description}}</th>
</tr>
</thead>

<tbody>
{{/syntax.parameters.0}}

{{#syntax.parameters}}
<tr>
<td>
<div class="parameter-type">
{{{type.specName.0.value}}}
</div>
<div class="parametername">
{{{id}}}
</div>
</td>
<td>{{{description}}}</td>
</tr>
{{/syntax.parameters}}

{{#syntax.parameters.0}}
</tbody>
</table>
{{/syntax.parameters.0}}

{{#syntax.return}}
<h5 class="returns">
{{__global.returns}}
</h5>

<table class="api-returns">
<thead>
<tr>
<th>{{__global.type}}</th>
<th>{{__global.description}}</th>
</tr>
</thead>

<tbody>
<tr>
<td>{{{type.specName.0.value}}}</td>
<td>{{{description}}}</td>
</tr>
</tbody>
</table>
{{/syntax.return}}

{{#syntax.typeParameters.0}}
<h5 class="typeParameters">
{{__global.typeParameters}}
</h5>

<table class="api-type-parameters">
<thead>
<tr>
<th>{{__global.name}}</th>
<th>{{__global.description}}</th>
</tr>
</thead>

<tbody>
{{/syntax.typeParameters.0}}

{{#syntax.typeParameters}}
<tr>
<td>
<span class="parametername">{{{id}}}</span>
</td>
<td>{{{description}}}</td>
</tr>
{{/syntax.typeParameters}}

{{#syntax.typeParameters.0}}
</tbody>
</table>
{{/syntax.typeParameters.0}}

{{#inheritedMembers.0}}
<dl class="typelist inheritedMembers">
<dt>{{__global.inheritedMembers}}</dt>
<dd>
{{/inheritedMembers.0}}
{{#inheritedMembers}}
<div>
{{#definition}}
<xref uid="{{definition}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
{{/definition}}
{{^definition}}
<xref uid="{{uid}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
{{/definition}}
</div>
{{/inheritedMembers}}
{{#inheritedMembers.0}}
</dd>
</dl>
{{/inheritedMembers.0}}

{{#extensionMethods.0}}
<dl class="typelist extensionMethods">
<dt>{{__global.extensionMethods}}</dt>
<dd>
{{/extensionMethods.0}}
{{#extensionMethods}}
<div>
{{#definition}}
<xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
{{/definition}}
{{^definition}}
<xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
{{/definition}}
</div>
{{/extensionMethods}}
{{#extensionMethods.0}}
</dd>
</dl>
{{/extensionMethods.0}}

{{#isEnum}}
{{#children}}
<h2 id="{{id}}">{{>partials/classSubtitle}}</h2>

<table class="api-fields">
<thead>
<tr>
<th>{{__global.name}}</th>
<th>{{__global.description}}</th>
</tr>
</thead>

<tbody>
{{#children}}
<tr>
<td>
<code>{{syntax.content.0.value}}</code>
</td>
<td>
{{{summary}}}
{{#remarks}}{{{remarks}}}{{/remarks}}
</td>
</tr>
{{/children}}
</tbody>
</table>

{{/children}}
{{/isEnum}}

{{#example.0}}
<h2 id="{{id}}_examples">{{__global.examples}}</h2>
{{/example.0}}
{{#example}}
{{{.}}}
{{/example}}

{{#remarks}}
<h2 id="{{id}}_remarks">{{__global.remarks}}</h2>
<div class="markdown level0 remarks">{{{remarks}}}</div>
{{/remarks}}
Loading
Loading