From 2814160d5d04760094c978f1f05ccf56814a119e Mon Sep 17 00:00:00 2001 From: AnnulusGames Date: Sun, 18 Feb 2024 12:37:45 +0900 Subject: [PATCH] Setup: docfx --- docs/.gitignore | 3 ++ docs/articles/ja/getting-started.md | 1 + docs/articles/ja/introduction.md | 1 + docs/articles/ja/toc.yml | 4 ++ docs/docfx.json | 72 +++++++++++++++++++++++++++++ docs/images/favicon.svg | 3 ++ docs/images/icon.svg | 6 +++ docs/index.md | 11 +++++ docs/toc.yml | 6 +++ 9 files changed, 107 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/articles/ja/getting-started.md create mode 100644 docs/articles/ja/introduction.md create mode 100644 docs/articles/ja/toc.yml create mode 100644 docs/docfx.json create mode 100644 docs/images/favicon.svg create mode 100644 docs/images/icon.svg create mode 100644 docs/index.md create mode 100644 docs/toc.yml diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..57ba112 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +.cache +/**/_site/ +*.DS_Store \ No newline at end of file diff --git a/docs/articles/ja/getting-started.md b/docs/articles/ja/getting-started.md new file mode 100644 index 0000000..8b3a794 --- /dev/null +++ b/docs/articles/ja/getting-started.md @@ -0,0 +1 @@ +# Getting Started \ No newline at end of file diff --git a/docs/articles/ja/introduction.md b/docs/articles/ja/introduction.md new file mode 100644 index 0000000..f6ecaa6 --- /dev/null +++ b/docs/articles/ja/introduction.md @@ -0,0 +1 @@ +# Introduction \ No newline at end of file diff --git a/docs/articles/ja/toc.yml b/docs/articles/ja/toc.yml new file mode 100644 index 0000000..d7e9ea8 --- /dev/null +++ b/docs/articles/ja/toc.yml @@ -0,0 +1,4 @@ +- name: Introduction + href: introduction.md +- name: Getting Started + href: getting-started.md \ No newline at end of file diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..d81ee55 --- /dev/null +++ b/docs/docfx.json @@ -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": "Copyright © 2024 Annulus Games. Generated with DocFX", + "_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" + } + } +} \ No newline at end of file diff --git a/docs/images/favicon.svg b/docs/images/favicon.svg new file mode 100644 index 0000000..3ba5762 --- /dev/null +++ b/docs/images/favicon.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/images/icon.svg b/docs/images/icon.svg new file mode 100644 index 0000000..376859e --- /dev/null +++ b/docs/images/icon.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..f9859f8 --- /dev/null +++ b/docs/index.md @@ -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. \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..ec1f46b --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,6 @@ +- name: Docs + href: en/ +- name: Docs (日本語) + href: ja/ +- name: API + href: api/ \ No newline at end of file