Skip to content

Commit

Permalink
Add docfx files
Browse files Browse the repository at this point in the history
  • Loading branch information
kochounoyume committed Dec 31, 2024
1 parent 535fc43 commit afd121f
Show file tree
Hide file tree
Showing 6 changed files with 94 additions and 0 deletions.
72 changes: 72 additions & 0 deletions Documentation/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
{
"metadata": [
{
"src": [
{
"src": "../Packages",
"files": [
"MinimalUtility/Runtime/**/*.cs",
"MinimalUtility/Editor/**/*.cs"
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false,
"allowCompilationErrors": true,
"properties": {
"DefineConstants": "ENABLE_MINIMAL_DEBUGGING;ENABLE_UNITASK;ENABLE_R3;ENABLE_UGUI;ENABLE_UITOOLKIT;ENABLE_VCONTAINER;ENABLE_WEBREQUEST"
}
}
],
"build": {
"content": [
{
"files": "**/*.{md,yml}",
"src": "api",
"dest": "api"
},
{
"files": [
"docs/**.md",
"docs/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"template": [
"default",
"modern"
],
"globalMetadata": {
"_appName": "MinimalUtility",
"_appTitle": "MinimalUtility",
"_appFooter": "<span>Copyright © 2024 kochounoyume. Generated with <a href=\"https://dotnet.github.io/docfx\">DocFX</a></span>",
"_enableSearch": true,
"pdf": true,
"_gitContribute": {
"repo": "https://github.com/kochounoyume/MinimalUtility"
},
"_gitUrlPattern": "github"
},
"xref": [
"https://normanderwan.github.io/UnityXrefMaps/xrefmap.yml",
"https://docs.unity3d.com/Packages/com.unity.ugui@1.0/xrefmap.yml"
],
"xrefService": [
"https://xref.docs.microsoft.com/query?uid={uid}"
],
"sitemap": {
"baseUrl": "https://kochounoyume.github.io/MinimalUtility/"
}
}
}
1 change: 1 addition & 0 deletions Documentation/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting Started
1 change: 1 addition & 0 deletions Documentation/docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Introduction
5 changes: 5 additions & 0 deletions Documentation/docs/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- name: サンプル
- name: Introduction
href: introduction.md
- name: Getting Started
href: getting-started.md
11 changes: 11 additions & 0 deletions Documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
_layout: landing
---

# This is the **HOMEPAGE**.

Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.

## Quick Start Notes:

1. Add images to the *images* folder if the file is referencing an image.
4 changes: 4 additions & 0 deletions Documentation/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Docs
href: docs/
- name: API
href: api/

0 comments on commit afd121f

Please sign in to comment.