Setup: docfx

This commit is contained in:
AnnulusGames 2024-02-18 12:37:45 +09:00
parent 2cc974d676
commit 2814160d5d
9 changed files with 107 additions and 0 deletions

3
docs/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
.cache
/**/_site/
*.DS_Store

View File

@ -0,0 +1 @@
# Getting Started

View File

@ -0,0 +1 @@
# Introduction

4
docs/articles/ja/toc.yml Normal file
View File

@ -0,0 +1,4 @@
- name: Introduction
href: introduction.md
- name: Getting Started
href: getting-started.md

72
docs/docfx.json Normal file
View File

@ -0,0 +1,72 @@
{
"metadata": [
{
"src": [
{
"files": [
"Alchemy/Assets/Alchemy/Runtime/**/*.cs",
"Alchemy/Assets/Alchemy/Editor/**/*.cs"
],
"src": "../src"
}
],
"properties": {
"AllowUnsafeBlocks": true
},
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false,
"allowCompilationErrors": true
}
],
"build": {
"content": [
{
"files": "**/*.{md,yml}",
"src": "api",
"dest": "api"
},
{
"files": [
"articles/en/**.md",
"articles/en/toc.yml",
"articles/ja/**.md",
"articles/ja/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"template": [
"default",
"modern"
],
"globalMetadata": {
"_appName": "Alchemy",
"_appTitle": "Alchemy",
"_appFooter": "<span>Copyright © 2024 Annulus Games. Generated with <a href=\"https://dotnet.github.io/docfx\">DocFX</a></span>",
"_enableSearch": true,
"pdf": false,
"_appLogoPath": "images/icon.svg",
"_appFaviconPath": "images/favicon.svg",
"_gitContribute": {
"repo": "https://github.com/AnnulusGames/Alchemy"
},
"_gitUrlPattern": "github"
},
"xrefService": [
"https://xref.docs.microsoft.com/query?uid={uid}"
],
"sitemap": {
"baseUrl": "https://AnnulusGames.github.io/Alchemy"
}
}
}

3
docs/images/favicon.svg Normal file
View File

@ -0,0 +1,3 @@
<svg width="64" height="64" viewBox="0 0 64 64" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M32.0631 1L29.3414 5.7142H31.5917V9.97893C19.7665 10.2266 10.2264 19.7667 9.97869 31.5918H1V32.5347H9.97868C10.2261 44.36 19.7664 53.9004 31.5917 54.148V63.1263H32.5345V54.148C44.3599 53.9005 53.9003 44.3601 54.1478 32.5347H58.4121V34.785L63.1263 32.0632L58.4121 29.3415V31.5918H54.1477C53.9 19.7666 44.3598 10.2264 32.5345 9.97893V5.7142H34.7849L32.0631 1ZM18.8178 31.5918C19.0607 24.647 24.6468 19.0609 31.5917 18.818V30.3906C31.0055 30.5441 30.5441 31.0057 30.3906 31.5918H18.8178ZM30.4161 32.5347H18.8178C19.0604 39.4797 24.6467 45.0661 31.5917 45.3089V33.6482C31.0351 33.5024 30.5909 33.0789 30.4161 32.5347ZM32.5345 33.6227V45.3089C39.4797 45.0662 45.066 39.4798 45.3087 32.5347H33.6227C33.4572 33.0501 33.05 33.4573 32.5345 33.6227ZM33.6482 31.5918H45.3087C45.0658 24.6469 39.4795 19.0607 32.5345 18.818V30.4161C33.0789 30.5908 33.5025 31.0351 33.6482 31.5918Z" fill="white"/>
</svg>

After

Width:  |  Height:  |  Size: 1.0 KiB

6
docs/images/icon.svg Normal file
View File

@ -0,0 +1,6 @@
<svg width="64" height="64" viewBox="0 0 64 64" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M55.125 32.0625L51.125 29.7531V34.3719L55.125 32.0625ZM9 32.4625H51.525V31.6625H9V32.4625Z" fill="#DEDEDE"/>
<path d="M32.0625 9L29.7531 13H34.3719L32.0625 9ZM32.4625 55.125V12.6H31.6625L31.6625 55.125H32.4625Z" fill="#DEDEDE"/>
<circle cx="32.0625" cy="32.0626" r="13.12" stroke="#DEDEDE" stroke-width="6.56002"/>
<circle cx="32.03" cy="32.03" r="1.25" fill="#DEDEDE"/>
</svg>

After

Width:  |  Height:  |  Size: 483 B

11
docs/index.md Normal file
View File

@ -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.

6
docs/toc.yml Normal file
View File

@ -0,0 +1,6 @@
- name: Docs
href: en/
- name: Docs (日本語)
href: ja/
- name: API
href: api/