Skip to content

Commit fee015a

Browse files
IrishBruseIrishBruse
committed
Documentation Wiki started using docfx
1 parent 8baaa5f commit fee015a

File tree

66 files changed

+21230
-53
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+21230
-53
lines changed

‎LDtkMonogame.code-workspace‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<p align="center">
2-
<a href="https://github.com/deepnight/ldtk"> <img alt="LDtk Version Support" src="https://img.shields.io/github/v/release/deepnight/ldtk?&label=Supports%20LDtk"></a>
3-
<a href="https://www.nuget.org/packages/LDtkMonogame/"><img src="https://img.shields.io/nuget/v/LDtkMonogame?" /></a>
4-
<a href="https://www.nuget.org/packages/LDtkMonogame/"><img alt="Nuget" src="https://img.shields.io/nuget/dt/LDtkMonogame"></a>
2+
<a href="https://github.com/deepnight/ldtk"> <img alt="LDtk Version Support" src="https://img.shields.io/github/v/release/deepnight/ldtk?&label=Supports%20LDtk"></a>
3+
<a href="https://www.nuget.org/packages/LDtkMonogame/"><img src="https://img.shields.io/nuget/v/LDtkMonogame?" /></a>
4+
<a href="https://www.nuget.org/packages/LDtkMonogame/"><img alt="Nuget" src="https://img.shields.io/nuget/dt/LDtkMonogame"></a>
55
</p>
66
<p align="center">
7-
<img alt="GitHub Package Build Status" src="https://img.shields.io/github/workflow/status/IrishBruse/LDtkMonogame/Build%20Package?label=LDtkMonogame">
8-
<img alt="GitHub Examples Build Status" src="https://img.shields.io/github/workflow/status/IrishBruse/LDtkMonogame/Build%20Examples?label=LDtkMonogame.Examples">
7+
<a href="https://github.com/IrishBruse/LDtkMonogame/tree/main/LDtkMonogame"> <img alt="GitHub Package Build Status" src="https://img.shields.io/github/workflow/status/IrishBruse/LDtkMonogame/Build%20Package?label=LDtkMonogame"></a>
8+
<a href="https://github.com/IrishBruse/LDtkMonogame/tree/main/LDtkMonogame.Examples"> <img alt="GitHub Examples Build Status" src="https://img.shields.io/github/workflow/status/IrishBruse/LDtkMonogame/Build%20Examples?label=LDtkMonogame.Examples"></a>
99
</p>
1010

1111
# LDtk Monogame

‎docs/index.html‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎wiki/docfx_project/.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
###############
2+
# folder #
3+
###############
4+
/**/DROP/
5+
/**/TEMP/
6+
/**/packages/
7+
/**/bin/
8+
/**/obj/
9+
_site

‎wiki/docfx_project/api/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml
5+
.manifest

‎wiki/docfx_project/api/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# PLACEHOLDER
2+
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!

‎wiki/docfx_project/articles/intro.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Add your introductions here!

‎wiki/docfx_project/articles/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: Introduction
2+
href: intro.md

‎wiki/docfx_project/docfx.json‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"src": "../LDtkMonogame",
7+
"files": ["**.csproj"],
8+
"exclude": ["Json/**"]
9+
}],
10+
"dest": "api",
11+
"disableGitFeatures": false,
12+
"disableDefaultFilter": false
13+
}],
14+
"build":
15+
{
16+
"content": [
17+
{
18+
"files": [
19+
"api/**.yml",
20+
"api/index.md"
21+
]
22+
},
23+
{
24+
"files": [
25+
"articles/**.md",
26+
"articles/**/toc.yml",
27+
"toc.yml",
28+
"*.md"
29+
]
30+
}],
31+
"resource": [
32+
{
33+
"files": [
34+
"images/**"
35+
]
36+
}],
37+
"overwrite": [
38+
{
39+
"files": [
40+
"apidoc/**.md"
41+
],
42+
"exclude": [
43+
"obj/**",
44+
"_site/**"
45+
]
46+
}],
47+
"dest": "../docs/",
48+
"globalMetadataFiles": [],
49+
"fileMetadataFiles": [],
50+
"template": [
51+
"default", "templates/darkfx"
52+
],
53+
"postProcessors": [],
54+
"markdownEngineName": "markdig",
55+
"noLangKeyword": false,
56+
"keepFileLink": false,
57+
"cleanupCacheHistory": false,
58+
"disableGitFeatures": false
59+
}
60+
}

‎wiki/docfx_project/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# This is the **HOMEPAGE**.
2+
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
3+
## Quick Start Notes:
4+
1. Add images to the *images* folder if the file is referencing an image.

0 commit comments

Comments
 (0)