├── .docfx_project ├── .gitignore ├── api.meta ├── api │ ├── .gitignore │ ├── index.md │ └── index.md.meta ├── docfx.json ├── docfx.json.meta ├── favicon.ico ├── index.md ├── index.md.meta ├── logo.svg ├── toc.yml └── toc.yml.meta ├── .github └── workflows │ └── main.yml ├── .gitignore ├── DocFxTemplate~ ├── .gitignore ├── api.meta ├── api │ ├── .gitignore │ ├── index.md │ └── index.md.meta ├── docfx.json ├── docfx.json.meta ├── favicon.ico ├── index.md ├── index.md.meta ├── logo.svg ├── toc.yml └── toc.yml.meta ├── Documentation~ └── api │ ├── .manifest │ ├── MacacaGames.DocGenerator.AsmdefFile.yml │ ├── MacacaGames.DocGenerator.Build.yml │ ├── MacacaGames.DocGenerator.Content.yml │ ├── MacacaGames.DocGenerator.DocFxSetting.yml │ ├── MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.yml │ ├── MacacaGames.DocGenerator.DocGeneratorWindow.yml │ ├── MacacaGames.DocGenerator.Metadata.yml │ ├── MacacaGames.DocGenerator.Overwrite.yml │ ├── MacacaGames.DocGenerator.Resource.yml │ ├── MacacaGames.DocGenerator.Src.yml │ ├── MacacaGames.DocGenerator.VersionDefine.yml │ ├── MacacaGames.DocGenerator.yml │ └── toc.yml ├── Editor.meta ├── Editor ├── DocGeneratorWindow.cs ├── DocGeneratorWindow.cs.meta ├── MacacaDocGenerator.asmdef ├── MacacaDocGenerator.asmdef.meta ├── Model.meta ├── Model │ ├── DocFxSetting.cs │ ├── DocFxSetting.cs.meta │ ├── UnityDocGeneratorSetting.cs │ └── UnityDocGeneratorSetting.cs.meta ├── PackageManger.meta ├── PackageManger │ ├── DocGeneratorPackageMangerExtension.cs │ └── DocGeneratorPackageMangerExtension.cs.meta ├── Utils.meta └── Utils │ ├── Excuter.cs │ ├── Excuter.cs.meta │ ├── SimpleHTTPServer.cs │ ├── SimpleHTTPServer.cs.meta │ ├── Utils.cs │ └── Utils.cs.meta ├── Img~ ├── 01.png ├── 01.png.meta ├── 02.png ├── 02.png.meta ├── 03.png ├── 03.png.meta ├── 04.png ├── 04.png.meta ├── 05.png ├── 05.png.meta ├── 06.png ├── 06.png.meta ├── 07.png └── 07.png.meta ├── Readme.md ├── Readme.md.meta ├── Tools~ ├── docfx.7z └── docfx.7z.meta ├── docs~ ├── Img~ │ ├── 01.png │ ├── 01.png.meta │ ├── 02.png │ ├── 02.png.meta │ ├── 03.png │ ├── 03.png.meta │ ├── 04.png │ ├── 04.png.meta │ ├── 05.png │ ├── 05.png.meta │ ├── 06.png │ ├── 06.png.meta │ ├── 07.png │ └── 07.png.meta ├── api │ ├── MacacaGames.DocGenerator.AsmdefFile.html │ ├── MacacaGames.DocGenerator.Build.html │ ├── MacacaGames.DocGenerator.Content.html │ ├── MacacaGames.DocGenerator.DocFxSetting.html │ ├── MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.html │ ├── MacacaGames.DocGenerator.DocGeneratorWindow.html │ ├── MacacaGames.DocGenerator.Metadata.html │ ├── MacacaGames.DocGenerator.Overwrite.html │ ├── MacacaGames.DocGenerator.Resource.html │ ├── MacacaGames.DocGenerator.Src.html │ ├── MacacaGames.DocGenerator.VersionDefine.html │ ├── MacacaGames.DocGenerator.html │ ├── index.html │ └── toc.html ├── favicon.ico ├── fonts │ ├── glyphicons-halflings-regular.eot │ ├── glyphicons-halflings-regular.svg │ ├── glyphicons-halflings-regular.ttf │ ├── glyphicons-halflings-regular.woff │ └── glyphicons-halflings-regular.woff2 ├── index.html ├── logo.svg ├── manifest.json ├── search-stopwords.json ├── styles │ ├── docfx.css │ ├── docfx.js │ ├── docfx.vendor.css │ ├── docfx.vendor.js │ ├── lunr.js │ ├── lunr.min.js │ ├── main.css │ ├── main.js │ └── search-worker.js ├── toc.html └── xrefmap.yml ├── package.json ├── package.json.meta ├── udg_setting.json └── udg_setting.json.meta /.docfx_project/.gitignore: -------------------------------------------------------------------------------- 1 | ############### 2 | # folder # 3 | ############### 4 | /**/DROP/ 5 | /**/TEMP/ 6 | /**/packages/ 7 | /**/bin/ 8 | /**/obj/ 9 | _site 10 | -------------------------------------------------------------------------------- /.docfx_project/api.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 6b65d18e786d14cfe81716b8946799fc 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /.docfx_project/api/.gitignore: -------------------------------------------------------------------------------- 1 | ############### 2 | # temp file # 3 | ############### 4 | *.yml 5 | .manifest 6 | -------------------------------------------------------------------------------- /.docfx_project/api/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to the Scripting Reference! 2 | Select the API to view the detail. -------------------------------------------------------------------------------- /.docfx_project/api/index.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 286310b0763504cf7acd6505a9f9cf0d 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /.docfx_project/docfx.json: -------------------------------------------------------------------------------- 1 | { 2 | "metadata": [ 3 | { 4 | "src": [ 5 | { 6 | "files": [ 7 | "Macaca.DocGenerator.csproj" 8 | ], 9 | "src": "../../../" 10 | } 11 | ], 12 | "dest": "../Documentation~/api", 13 | "disableGitFeatures": false, 14 | "disableDefaultFilter": false, 15 | "filter": "" 16 | } 17 | ], 18 | "build": { 19 | "content": [ 20 | { 21 | "src": "", 22 | "files": [ 23 | "index.md", 24 | "**.yml", 25 | "api/**.yml", 26 | "api/index.md" 27 | ] 28 | }, 29 | { 30 | "src": "../Documentation~", 31 | "files": [ 32 | "*.md", 33 | "*.yml", 34 | "**/*.md", 35 | "**/*.yml" 36 | ] 37 | } 38 | ], 39 | "resource": [ 40 | { 41 | "src": "", 42 | "files": [ 43 | "images/**", 44 | "favicon.ico", 45 | "logo.svg" 46 | ] 47 | } 48 | ], 49 | "overwrite": [ 50 | { 51 | "files": [ 52 | "apidoc/**.md" 53 | ], 54 | "exclude": [ 55 | "obj/**", 56 | "_site/**" 57 | ] 58 | } 59 | ], 60 | "dest": "../docs~", 61 | "template": [ 62 | "default" 63 | ], 64 | "markdownEngineName": "markdig", 65 | "noLangKeyword": false, 66 | "keepFileLink": false, 67 | "cleanupCacheHistory": false, 68 | "disableGitFeatures": false 69 | } 70 | } -------------------------------------------------------------------------------- /.docfx_project/docfx.json.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: ab8d60c5b999b49b29428b1c2697b6fa 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /.docfx_project/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/.docfx_project/favicon.ico -------------------------------------------------------------------------------- /.docfx_project/index.md: -------------------------------------------------------------------------------- 1 | # UnityDocGenerator 2 | A helper to make docfx based document in Unity3D 3 | 4 | ## Features 5 | - Document generate based on [Docfx](https://github.com/dotnet/docfx) in Unity3D 6 | - Generate document depend on Unity [Assembly definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html) (.asmdef) files. 7 | - Document web preview hosting in Unity3D. 8 | - Tested on Windows Editor, OSX Editor. 9 | 10 | ## Pre-requisites 11 | UnityDocGenerator require the package manager ui extension mechanism, which is available from version 1.9.3 or later, or remove PackageManager/DocGeneratorPackageManagerExtension.cs to break the Package Manger UI supportion. 12 | ## Installtion 13 | Add the following line to Packages/manifest.json: 14 | ```json 15 | "com.macacagames.docgenerator": "https://github.com/MacacaGames/UnityDocGenerator.git#1.0.0", 16 | ``` 17 | 18 | ### Environment Setup 19 | #### macOS, Linux 20 | Make sure Mono Framework runtime is installed in your computer. 21 | [Download Here](https://www.mono-project.com/download/stable/) 22 | #### Windows 23 | Make sure MSBuild >= 1.5 is installed in your computer. 24 | One of the easiest way is Install the Visual Studio >= 2013. 25 | [Get Visual Studio](https://visualstudio.microsoft.com/zh-hant/downloads/) 26 | 27 | ## Getting Started 28 | ### 1. Open Editor 29 | 30 | - Option 1 (recommend): You can press the **Open with Unity Doc Generator** button on an installed packages to open the UnityDocGenerator. 31 | 32 | 33 | 34 | - Option 2: In Project window you can use Assets Menu to open a folder directly by click **Open with Unity Doc Generator** (This method may not work corrrectly if the folder name contains the "." char) 35 | 36 | 37 | 38 | - Option 3: Open the editor via Unity's toolbar, MacacaGames > UnityDocGenerator 39 | 40 | ### 2. Get the full path of your mono install. 41 | macOS, Linux only! Windows user can skip this step. 42 | 43 | ```bash 44 | which mono 45 | ``` 46 | If the Mono Framework is install correctlly, you may got the return like this. 47 | ```bash 48 | /Library/Frameworks/Mono.framework/Versions/Current/Commands/mono 49 | ``` 50 | Then paste the value to the Mono Path field on Editor. 51 | 52 | 53 | 54 | ### 3. Select your working folder 55 | Type the working folder path or use **Select Folder** select via dialog. 56 | (If the Editor is open via Option 1. or Option 2. the value will fill-up automatically) 57 | 58 | 59 | 60 | UnityDocGenerator will find out all Unity [Assembly definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html) (.asmdef) files inside the folder (include all sub folder) as the DocFx target. 61 | 62 | For example, the screeshot shows there will be 2 files set to DocFx target. 63 | 64 | 65 | 66 | ### 4. Generate!! 67 | Click **Generate Document** and wait for the task complete. 68 | The Unity Editor may hangs during the docfx runing, it is normal and usually resume in 1 min (Based on your project size). 69 | 70 | You can see the DocFx result in Unity Editor Console. 71 | 72 | 73 | 74 | ### 5. Hosting and preview (Optional) 75 | You can preview you generated document via UnityDocGenerator. 76 | Click **Start Hosting** to enable hosting, navigate to http://127.0.0.1:18080/index to view your generated document. 77 | 78 | Hosgint power by [sableangle/UnityHTTPServer](https://github.com/sableangle/UnityHTTPServer) 79 | 80 | 81 | 82 | ### 6. Next Step? 83 | Upload your document to your web server. 84 | The generated html document is in ``/docs~`` folder 85 | 86 | ## Project Struction 87 | UnityDocGenerator will generate two folders in your working folder. 88 | Only modify them if you understand what you're doing, eg.. more custom modify for docfx. 89 | 90 | UnityDocGenerator use .docfx_project/docfx.json as the DocFx setting to generate document. 91 | 92 | ``` 93 | ─ root (The working folder you select) 94 | └─ /your sub folders... 95 | └─ your files... 96 | └─ /.docfx_project (The DocFx project generate by UnityDocGenerator) 97 | └─ docfx.json (DocFx setting file) 98 | └─ other docfx project files... 99 | └─ /docs~ (The generated html document) 100 | └─ /Documentation~ (The generated document) 101 | └─ udg_setting.json (The UnityDocGenerator setting file) 102 | ``` 103 | 104 | ## Customize 105 | You can make your change on DocFx project. The DocFx project is under "{ProjectRoot}/.docfx_project" folder. 106 | See DocFx document for more detail to modify. 107 | 108 | 109 | ## Troubleshooting 110 | - Try to find the error message in Unity Editor Console. 111 | - Make sure you Mono Framework is install correctlly. 112 | - Open an issue on Github if there is any bug, and provide the project which reproduce the issue (if possiable). 113 | - Linux Editor is supported in theory but not tested. 114 | 115 | ## TODO 116 | - More custom setting for docfx. 117 | 118 | 119 | -------------------------------------------------------------------------------- /.docfx_project/index.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 6466d063b97894ffaa29b6fad3f2b5a8 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /.docfx_project/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /.docfx_project/toc.yml: -------------------------------------------------------------------------------- 1 | - name: Scripting API 2 | href: api/ 3 | homepage: api/index.md 4 | -------------------------------------------------------------------------------- /.docfx_project/toc.yml.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 14c9a60dc33164e56a40e4a2613a4064 3 | DefaultImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: github pages 2 | 3 | on: 4 | workflow_dispatch: 5 | push: 6 | branches: 7 | - master 8 | paths: 9 | - 'docs~/**' 10 | 11 | jobs: 12 | deploy: 13 | runs-on: ubuntu-18.04 14 | steps: 15 | - uses: actions/checkout@v2 16 | with: 17 | submodules: true # Fetch Hugo themes (true OR recursive) 18 | fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod 19 | - name: Deploy 20 | uses: peaceiris/actions-gh-pages@v3 21 | with: 22 | github_token: ${{ secrets.GITHUB_TOKEN }} 23 | publish_dir: ./docs~ 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | 4 | # User-specific files 5 | *.suo 6 | *.user 7 | *.sln.docstates 8 | 9 | # Build results 10 | 11 | [Dd]ebug/ 12 | [Rr]elease/ 13 | x64/ 14 | [Bb]in/ 15 | [Oo]bj/ 16 | 17 | # MSTest test Results 18 | [Tt]est[Rr]esult*/ 19 | [Bb]uild[Ll]og.* 20 | 21 | *_i.c 22 | *_p.c 23 | *_i.h 24 | *.ilk 25 | *.obj 26 | *.pch 27 | *.pdb 28 | *.pgc 29 | *.pgd 30 | *.rsp 31 | *.sbr 32 | *.tlb 33 | *.tli 34 | *.tlh 35 | *.tmp 36 | *.tmp_proj 37 | *.log 38 | *.vspscc 39 | *.vssscc 40 | .builds 41 | *.pidb 42 | *.log 43 | *.svclog 44 | *.scc 45 | 46 | # Visual C++ cache files 47 | ipch/ 48 | *.aps 49 | *.ncb 50 | *.opensdf 51 | *.sdf 52 | *.cachefile 53 | 54 | # Visual Studio profiler 55 | *.psess 56 | *.vsp 57 | *.vspx 58 | 59 | # Guidance Automation Toolkit 60 | *.gpState 61 | 62 | # ReSharper is a .NET coding add-in 63 | _ReSharper*/ 64 | *.[Rr]e[Ss]harper 65 | *.DotSettings.user 66 | 67 | # Click-Once directory 68 | publish/ 69 | 70 | # Publish Web Output 71 | *.Publish.xml 72 | *.pubxml 73 | *.azurePubxml 74 | 75 | # NuGet Packages Directory 76 | ## TODO: If you have NuGet Package Restore enabled, uncomment the next line 77 | packages/ 78 | ## TODO: If the tool you use requires repositories.config, also uncomment the next line 79 | !packages/repositories.config 80 | 81 | # Windows Azure Build Output 82 | csx/ 83 | *.build.csdef 84 | 85 | # Windows Store app package directory 86 | AppPackages/ 87 | 88 | # Others 89 | sql/ 90 | *.Cache 91 | ClientBin/ 92 | [Ss]tyle[Cc]op.* 93 | ![Ss]tyle[Cc]op.targets 94 | 95 | *.dbmdl 96 | *.[Pp]ublish.xml 97 | 98 | *.publishsettings 99 | 100 | # RIA/Silverlight projects 101 | Generated_Code/ 102 | 103 | # Backup & report files from converting an old project file to a newer 104 | # Visual Studio version. Backup files are not needed, because we have git ;-) 105 | _UpgradeReport_Files/ 106 | Backup*/ 107 | UpgradeLog*.XML 108 | UpgradeLog*.htm 109 | 110 | # SQL Server files 111 | App_Data/*.mdf 112 | App_Data/*.ldf 113 | 114 | # ========================= 115 | # Windows detritus 116 | # ========================= 117 | 118 | # Windows image file caches 119 | Thumbs.db 120 | ehthumbs.db 121 | 122 | # Folder config file 123 | Desktop.ini 124 | 125 | # Recycle Bin used on file shares 126 | $RECYCLE.BIN/ 127 | 128 | # Mac desktop service store files 129 | .DS_Store 130 | 131 | _NCrunch* 132 | 133 | [t]Temp -------------------------------------------------------------------------------- /DocFxTemplate~/.gitignore: -------------------------------------------------------------------------------- 1 | ############### 2 | # folder # 3 | ############### 4 | /**/DROP/ 5 | /**/TEMP/ 6 | /**/packages/ 7 | /**/bin/ 8 | /**/obj/ 9 | _site 10 | -------------------------------------------------------------------------------- /DocFxTemplate~/api.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 6b65d18e786d14cfe81716b8946799fc 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /DocFxTemplate~/api/.gitignore: -------------------------------------------------------------------------------- 1 | ############### 2 | # temp file # 3 | ############### 4 | *.yml 5 | .manifest 6 | -------------------------------------------------------------------------------- /DocFxTemplate~/api/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to the Scripting Reference! 2 | Select the API to view the detail. -------------------------------------------------------------------------------- /DocFxTemplate~/api/index.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 286310b0763504cf7acd6505a9f9cf0d 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /DocFxTemplate~/docfx.json: -------------------------------------------------------------------------------- 1 | { 2 | "metadata": [ 3 | { 4 | "src": [ 5 | { 6 | "files": [ 7 | "src/**.csproj" 8 | ] 9 | } 10 | ], 11 | "dest": "../Documentation~/api", 12 | "disableGitFeatures": false, 13 | "disableDefaultFilter": false 14 | } 15 | ], 16 | "build": { 17 | "content": [ 18 | { 19 | "src": "", 20 | "files": [ 21 | "index.md", 22 | "**.yml", 23 | "api/**.yml", 24 | "api/index.md" 25 | ] 26 | }, 27 | { 28 | "src": "../Documentation~", 29 | "files": [ 30 | "*.md", 31 | "*.yml", 32 | "**/*.md", 33 | "**/*.yml" 34 | ] 35 | } 36 | ], 37 | "resource": [ 38 | { 39 | "files": [ 40 | "images/**", 41 | "favicon.ico", 42 | "logo.svg" 43 | ] 44 | } 45 | ], 46 | "overwrite": [ 47 | { 48 | "files": [ 49 | "apidoc/**.md" 50 | ], 51 | "exclude": [ 52 | "obj/**", 53 | "_site/**" 54 | ] 55 | } 56 | ], 57 | "dest": "../docs", 58 | "globalMetadataFiles": [], 59 | "fileMetadataFiles": [], 60 | "template": [ 61 | "default" 62 | ], 63 | "postProcessors": [], 64 | "markdownEngineName": "markdig", 65 | "noLangKeyword": false, 66 | "keepFileLink": false, 67 | "cleanupCacheHistory": false, 68 | "disableGitFeatures": false 69 | } 70 | } -------------------------------------------------------------------------------- /DocFxTemplate~/docfx.json.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: ab8d60c5b999b49b29428b1c2697b6fa 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /DocFxTemplate~/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/DocFxTemplate~/favicon.ico -------------------------------------------------------------------------------- /DocFxTemplate~/index.md: -------------------------------------------------------------------------------- 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. 5 | -------------------------------------------------------------------------------- /DocFxTemplate~/index.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 6466d063b97894ffaa29b6fad3f2b5a8 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /DocFxTemplate~/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /DocFxTemplate~/toc.yml: -------------------------------------------------------------------------------- 1 | - name: Scripting API 2 | href: api/ 3 | homepage: api/index.md 4 | -------------------------------------------------------------------------------- /DocFxTemplate~/toc.yml.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 14c9a60dc33164e56a40e4a2613a4064 3 | DefaultImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /Documentation~/api/.manifest: -------------------------------------------------------------------------------- 1 | { 2 | "MacacaGames.DocGenerator": "MacacaGames.DocGenerator.yml", 3 | "MacacaGames.DocGenerator.AsmdefFile": "MacacaGames.DocGenerator.AsmdefFile.yml", 4 | "MacacaGames.DocGenerator.AsmdefFile.allowUnsafeCode": "MacacaGames.DocGenerator.AsmdefFile.yml", 5 | "MacacaGames.DocGenerator.AsmdefFile.autoReferenced": "MacacaGames.DocGenerator.AsmdefFile.yml", 6 | "MacacaGames.DocGenerator.AsmdefFile.defineConstraints": "MacacaGames.DocGenerator.AsmdefFile.yml", 7 | "MacacaGames.DocGenerator.AsmdefFile.excludePlatforms": "MacacaGames.DocGenerator.AsmdefFile.yml", 8 | "MacacaGames.DocGenerator.AsmdefFile.includePlatforms": "MacacaGames.DocGenerator.AsmdefFile.yml", 9 | "MacacaGames.DocGenerator.AsmdefFile.name": "MacacaGames.DocGenerator.AsmdefFile.yml", 10 | "MacacaGames.DocGenerator.AsmdefFile.noEngineReferences": "MacacaGames.DocGenerator.AsmdefFile.yml", 11 | "MacacaGames.DocGenerator.AsmdefFile.overrideReferences": "MacacaGames.DocGenerator.AsmdefFile.yml", 12 | "MacacaGames.DocGenerator.AsmdefFile.precompiledReferences": "MacacaGames.DocGenerator.AsmdefFile.yml", 13 | "MacacaGames.DocGenerator.AsmdefFile.references": "MacacaGames.DocGenerator.AsmdefFile.yml", 14 | "MacacaGames.DocGenerator.AsmdefFile.versionDefines": "MacacaGames.DocGenerator.AsmdefFile.yml", 15 | "MacacaGames.DocGenerator.Build": "MacacaGames.DocGenerator.Build.yml", 16 | "MacacaGames.DocGenerator.Build.cleanupCacheHistory": "MacacaGames.DocGenerator.Build.yml", 17 | "MacacaGames.DocGenerator.Build.content": "MacacaGames.DocGenerator.Build.yml", 18 | "MacacaGames.DocGenerator.Build.dest": "MacacaGames.DocGenerator.Build.yml", 19 | "MacacaGames.DocGenerator.Build.disableGitFeatures": "MacacaGames.DocGenerator.Build.yml", 20 | "MacacaGames.DocGenerator.Build.fileMetadataFiles": "MacacaGames.DocGenerator.Build.yml", 21 | "MacacaGames.DocGenerator.Build.globalMetadataFiles": "MacacaGames.DocGenerator.Build.yml", 22 | "MacacaGames.DocGenerator.Build.keepFileLink": "MacacaGames.DocGenerator.Build.yml", 23 | "MacacaGames.DocGenerator.Build.markdownEngineName": "MacacaGames.DocGenerator.Build.yml", 24 | "MacacaGames.DocGenerator.Build.noLangKeyword": "MacacaGames.DocGenerator.Build.yml", 25 | "MacacaGames.DocGenerator.Build.overwrite": "MacacaGames.DocGenerator.Build.yml", 26 | "MacacaGames.DocGenerator.Build.postProcessors": "MacacaGames.DocGenerator.Build.yml", 27 | "MacacaGames.DocGenerator.Build.resource": "MacacaGames.DocGenerator.Build.yml", 28 | "MacacaGames.DocGenerator.Build.template": "MacacaGames.DocGenerator.Build.yml", 29 | "MacacaGames.DocGenerator.Content": "MacacaGames.DocGenerator.Content.yml", 30 | "MacacaGames.DocGenerator.Content.files": "MacacaGames.DocGenerator.Content.yml", 31 | "MacacaGames.DocGenerator.Content.src": "MacacaGames.DocGenerator.Content.yml", 32 | "MacacaGames.DocGenerator.DocFxSetting": "MacacaGames.DocGenerator.DocFxSetting.yml", 33 | "MacacaGames.DocGenerator.DocFxSetting.build": "MacacaGames.DocGenerator.DocFxSetting.yml", 34 | "MacacaGames.DocGenerator.DocFxSetting.metadata": "MacacaGames.DocGenerator.DocFxSetting.yml", 35 | "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension": "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.yml", 36 | "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.CreateExtensionUI": "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.yml", 37 | "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.OnPackageAddedOrUpdated(UnityEditor.PackageManager.PackageInfo)": "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.yml", 38 | "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.OnPackageRemoved(UnityEditor.PackageManager.PackageInfo)": "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.yml", 39 | "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.OnPackageSelectionChange(UnityEditor.PackageManager.PackageInfo)": "MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.yml", 40 | "MacacaGames.DocGenerator.DocGeneratorWindow": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 41 | "MacacaGames.DocGenerator.DocGeneratorWindow.currentSelectPath": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 42 | "MacacaGames.DocGenerator.DocGeneratorWindow.Docfx": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 43 | "MacacaGames.DocGenerator.DocGeneratorWindow.DocFxProject": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 44 | "MacacaGames.DocGenerator.DocGeneratorWindow.Instance": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 45 | "MacacaGames.DocGenerator.DocGeneratorWindow.isGenerateAvailable": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 46 | "MacacaGames.DocGenerator.DocGeneratorWindow.OpenByDocGenerator": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 47 | "MacacaGames.DocGenerator.DocGeneratorWindow.OpenWindow": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 48 | "MacacaGames.DocGenerator.DocGeneratorWindow.settingFile": "MacacaGames.DocGenerator.DocGeneratorWindow.yml", 49 | "MacacaGames.DocGenerator.Metadata": "MacacaGames.DocGenerator.Metadata.yml", 50 | "MacacaGames.DocGenerator.Metadata.dest": "MacacaGames.DocGenerator.Metadata.yml", 51 | "MacacaGames.DocGenerator.Metadata.disableDefaultFilter": "MacacaGames.DocGenerator.Metadata.yml", 52 | "MacacaGames.DocGenerator.Metadata.disableGitFeatures": "MacacaGames.DocGenerator.Metadata.yml", 53 | "MacacaGames.DocGenerator.Metadata.filter": "MacacaGames.DocGenerator.Metadata.yml", 54 | "MacacaGames.DocGenerator.Metadata.src": "MacacaGames.DocGenerator.Metadata.yml", 55 | "MacacaGames.DocGenerator.Overwrite": "MacacaGames.DocGenerator.Overwrite.yml", 56 | "MacacaGames.DocGenerator.Overwrite.exclude": "MacacaGames.DocGenerator.Overwrite.yml", 57 | "MacacaGames.DocGenerator.Overwrite.files": "MacacaGames.DocGenerator.Overwrite.yml", 58 | "MacacaGames.DocGenerator.Resource": "MacacaGames.DocGenerator.Resource.yml", 59 | "MacacaGames.DocGenerator.Resource.files": "MacacaGames.DocGenerator.Resource.yml", 60 | "MacacaGames.DocGenerator.Resource.src": "MacacaGames.DocGenerator.Resource.yml", 61 | "MacacaGames.DocGenerator.Src": "MacacaGames.DocGenerator.Src.yml", 62 | "MacacaGames.DocGenerator.Src.files": "MacacaGames.DocGenerator.Src.yml", 63 | "MacacaGames.DocGenerator.Src.src": "MacacaGames.DocGenerator.Src.yml", 64 | "MacacaGames.DocGenerator.VersionDefine": "MacacaGames.DocGenerator.VersionDefine.yml", 65 | "MacacaGames.DocGenerator.VersionDefine.define": "MacacaGames.DocGenerator.VersionDefine.yml", 66 | "MacacaGames.DocGenerator.VersionDefine.expression": "MacacaGames.DocGenerator.VersionDefine.yml", 67 | "MacacaGames.DocGenerator.VersionDefine.name": "MacacaGames.DocGenerator.VersionDefine.yml" 68 | } -------------------------------------------------------------------------------- /Documentation~/api/MacacaGames.DocGenerator.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:ManagedReference 2 | items: 3 | - uid: MacacaGames.DocGenerator 4 | commentId: N:MacacaGames.DocGenerator 5 | id: MacacaGames.DocGenerator 6 | children: 7 | - MacacaGames.DocGenerator.AsmdefFile 8 | - MacacaGames.DocGenerator.Build 9 | - MacacaGames.DocGenerator.Content 10 | - MacacaGames.DocGenerator.DocFxSetting 11 | - MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension 12 | - MacacaGames.DocGenerator.DocGeneratorWindow 13 | - MacacaGames.DocGenerator.Metadata 14 | - MacacaGames.DocGenerator.Overwrite 15 | - MacacaGames.DocGenerator.Resource 16 | - MacacaGames.DocGenerator.Src 17 | - MacacaGames.DocGenerator.VersionDefine 18 | langs: 19 | - csharp 20 | - vb 21 | name: MacacaGames.DocGenerator 22 | nameWithType: MacacaGames.DocGenerator 23 | fullName: MacacaGames.DocGenerator 24 | type: Namespace 25 | assemblies: 26 | - Macaca.DocGenerator 27 | references: 28 | - uid: MacacaGames.DocGenerator.DocGeneratorWindow 29 | commentId: T:MacacaGames.DocGenerator.DocGeneratorWindow 30 | parent: MacacaGames.DocGenerator 31 | name: DocGeneratorWindow 32 | nameWithType: DocGeneratorWindow 33 | fullName: MacacaGames.DocGenerator.DocGeneratorWindow 34 | - uid: MacacaGames.DocGenerator.VersionDefine 35 | commentId: T:MacacaGames.DocGenerator.VersionDefine 36 | name: VersionDefine 37 | nameWithType: VersionDefine 38 | fullName: MacacaGames.DocGenerator.VersionDefine 39 | - uid: MacacaGames.DocGenerator.AsmdefFile 40 | commentId: T:MacacaGames.DocGenerator.AsmdefFile 41 | name: AsmdefFile 42 | nameWithType: AsmdefFile 43 | fullName: MacacaGames.DocGenerator.AsmdefFile 44 | - uid: MacacaGames.DocGenerator.DocFxSetting 45 | commentId: T:MacacaGames.DocGenerator.DocFxSetting 46 | name: DocFxSetting 47 | nameWithType: DocFxSetting 48 | fullName: MacacaGames.DocGenerator.DocFxSetting 49 | - uid: MacacaGames.DocGenerator.Src 50 | commentId: T:MacacaGames.DocGenerator.Src 51 | name: Src 52 | nameWithType: Src 53 | fullName: MacacaGames.DocGenerator.Src 54 | - uid: MacacaGames.DocGenerator.Metadata 55 | commentId: T:MacacaGames.DocGenerator.Metadata 56 | name: Metadata 57 | nameWithType: Metadata 58 | fullName: MacacaGames.DocGenerator.Metadata 59 | - uid: MacacaGames.DocGenerator.Content 60 | commentId: T:MacacaGames.DocGenerator.Content 61 | name: Content 62 | nameWithType: Content 63 | fullName: MacacaGames.DocGenerator.Content 64 | - uid: MacacaGames.DocGenerator.Resource 65 | commentId: T:MacacaGames.DocGenerator.Resource 66 | name: Resource 67 | nameWithType: Resource 68 | fullName: MacacaGames.DocGenerator.Resource 69 | - uid: MacacaGames.DocGenerator.Overwrite 70 | commentId: T:MacacaGames.DocGenerator.Overwrite 71 | name: Overwrite 72 | nameWithType: Overwrite 73 | fullName: MacacaGames.DocGenerator.Overwrite 74 | - uid: MacacaGames.DocGenerator.Build 75 | commentId: T:MacacaGames.DocGenerator.Build 76 | parent: MacacaGames.DocGenerator 77 | name: Build 78 | nameWithType: Build 79 | fullName: MacacaGames.DocGenerator.Build 80 | - uid: MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension 81 | commentId: T:MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension 82 | name: DocGeneratorPackageMangerExtension 83 | nameWithType: DocGeneratorPackageMangerExtension 84 | fullName: MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension 85 | - uid: MacacaGames.DocGenerator 86 | commentId: N:MacacaGames.DocGenerator 87 | name: MacacaGames.DocGenerator 88 | nameWithType: MacacaGames.DocGenerator 89 | fullName: MacacaGames.DocGenerator 90 | -------------------------------------------------------------------------------- /Documentation~/api/toc.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TableOfContent 2 | - uid: MacacaGames.DocGenerator 3 | name: MacacaGames.DocGenerator 4 | items: 5 | - uid: MacacaGames.DocGenerator.AsmdefFile 6 | name: AsmdefFile 7 | - uid: MacacaGames.DocGenerator.Build 8 | name: Build 9 | - uid: MacacaGames.DocGenerator.Content 10 | name: Content 11 | - uid: MacacaGames.DocGenerator.DocFxSetting 12 | name: DocFxSetting 13 | - uid: MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension 14 | name: DocGeneratorPackageMangerExtension 15 | - uid: MacacaGames.DocGenerator.DocGeneratorWindow 16 | name: DocGeneratorWindow 17 | - uid: MacacaGames.DocGenerator.Metadata 18 | name: Metadata 19 | - uid: MacacaGames.DocGenerator.Overwrite 20 | name: Overwrite 21 | - uid: MacacaGames.DocGenerator.Resource 22 | name: Resource 23 | - uid: MacacaGames.DocGenerator.Src 24 | name: Src 25 | - uid: MacacaGames.DocGenerator.VersionDefine 26 | name: VersionDefine 27 | -------------------------------------------------------------------------------- /Editor.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 8e651d0b92ca449d48dfbac910924fba 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /Editor/DocGeneratorWindow.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: b8aab66736c9044b7aa1cde61d25b653 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Editor/MacacaDocGenerator.asmdef: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Macaca.DocGenerator", 3 | "references": [], 4 | "includePlatforms": [ 5 | "Editor" 6 | ], 7 | "excludePlatforms": [], 8 | "allowUnsafeCode": false, 9 | "overrideReferences": false, 10 | "precompiledReferences": [ 11 | "DemiEditor.dll" 12 | ], 13 | "autoReferenced": true, 14 | "defineConstraints": [], 15 | "versionDefines": [], 16 | "noEngineReferences": false 17 | } -------------------------------------------------------------------------------- /Editor/MacacaDocGenerator.asmdef.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 921cd0e669c4f482d886d0737344c77e 3 | AssemblyDefinitionImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /Editor/Model.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 32cdd145eb1fc4191ad34c4e529a4e88 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /Editor/Model/DocFxSetting.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using UnityEngine; 3 | 4 | namespace MacacaGames.DocGenerator 5 | { 6 | [System.Serializable] 7 | public class VersionDefine 8 | { 9 | [SerializeField] 10 | public string name; 11 | public string expression; 12 | public string define; 13 | } 14 | 15 | /// 16 | /// AsmdefFile json model 17 | /// 18 | [System.Serializable] 19 | public class AsmdefFile 20 | { 21 | public string name; 22 | public List references; 23 | public List includePlatforms; 24 | public List excludePlatforms; 25 | public bool allowUnsafeCode; 26 | public bool overrideReferences; 27 | public List precompiledReferences; 28 | public bool autoReferenced; 29 | public List defineConstraints; 30 | public List versionDefines; 31 | public bool noEngineReferences; 32 | } 33 | 34 | /// 35 | /// Docfx json model 36 | /// 37 | [System.Serializable] 38 | public class DocFxSetting 39 | { 40 | public List metadata; 41 | public Build build; 42 | } 43 | [System.Serializable] 44 | public class Src 45 | { 46 | public List files; 47 | public string src; 48 | } 49 | 50 | [System.Serializable] 51 | public class Metadata 52 | { 53 | public List src; 54 | public string dest; 55 | public bool disableGitFeatures; 56 | public bool disableDefaultFilter; 57 | public string filter= ""; 58 | } 59 | 60 | [System.Serializable] 61 | public class Content 62 | { 63 | public string src =""; 64 | public List files; 65 | } 66 | 67 | [System.Serializable] 68 | public class Resource 69 | { 70 | public string src = ""; 71 | public List files; 72 | } 73 | 74 | [System.Serializable] 75 | public class Overwrite 76 | { 77 | public List files; 78 | public List exclude; 79 | } 80 | 81 | [System.Serializable] 82 | public class Build 83 | { 84 | public List content; 85 | public List resource; 86 | public List overwrite; 87 | public string dest; 88 | public List globalMetadataFiles; 89 | public List fileMetadataFiles; 90 | public List template; 91 | public List postProcessors; 92 | public string markdownEngineName; 93 | public bool noLangKeyword; 94 | public bool keepFileLink; 95 | public bool cleanupCacheHistory; 96 | public bool disableGitFeatures; 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /Editor/Model/DocFxSetting.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 15404b9c55c1d45ada97f1c909597b53 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Editor/Model/UnityDocGeneratorSetting.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | 3 | public class UnityDocGeneratorSetting 4 | { 5 | public bool copyReadmeToDocfxIndex = true; 6 | public bool disableDefaultFilter = false; 7 | public bool disableGitFeatures = false; 8 | public List copyFolderToDocument = new List(); 9 | } -------------------------------------------------------------------------------- /Editor/Model/UnityDocGeneratorSetting.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 42459bb3c4213403389f1bf1e8c9d9ad 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Editor/PackageManger.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 5f6ec95aaa118410b962ce2093d3ec5c 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /Editor/PackageManger/DocGeneratorPackageMangerExtension.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections; 3 | using System.Collections.Generic; 4 | using UnityEditor; 5 | using UnityEditor.PackageManager; 6 | using UnityEditor.PackageManager.UI; 7 | using UnityEngine; 8 | #if UNITY_2019_1_OR_NEWER 9 | using UnityEngine.UIElements; 10 | #else 11 | using UnityEngine.Experimental.UIElements; 12 | #endif 13 | 14 | namespace MacacaGames.DocGenerator 15 | { 16 | [InitializeOnLoad] 17 | public class DocGeneratorPackageMangerExtension : IPackageManagerExtension 18 | { 19 | private UnityEditor.PackageManager.PackageInfo packageInfo; 20 | string packagePath; 21 | public VisualElement CreateExtensionUI() 22 | { 23 | return new IMGUIContainer(OnGUI); 24 | } 25 | 26 | private void OnGUI() 27 | { 28 | using (var horizon = new GUILayout.HorizontalScope()) 29 | { 30 | if (GUILayout.Button(new GUIContent("Open with Unity Doc Generator", "Open Unity Doc Generator for more detail settings"))) 31 | { 32 | DocGeneratorWindow.OpenWindow(); 33 | DocGeneratorWindow.currentSelectPath = packagePath; 34 | } 35 | string p1 = System.IO.Path.Combine(packagePath, DocGeneratorWindow.settingFile); 36 | string p2 = System.IO.Path.Combine(packagePath, DocGeneratorWindow.DocFxProject); 37 | bool isSettingExsit = System.IO.File.Exists(p1); 38 | bool isDocFxDocumentExsit = System.IO.Directory.Exists(p2); 39 | bool buildDirectAvailable = !(isSettingExsit && isDocFxDocumentExsit); 40 | using (var disable = new EditorGUI.DisabledGroupScope(buildDirectAvailable)) 41 | { 42 | if (GUILayout.Button(new GUIContent("Generate Doc with last setting", "Require the package has generate document using UnityDocGenerator before"))) 43 | { 44 | DocGeneratorWindow.OpenWindow(); 45 | DocGeneratorWindow.currentSelectPath = System.IO.Path.GetFullPath(packageInfo.assetPath); 46 | DocGeneratorWindow.Instance.Docfx(); 47 | } 48 | } 49 | } 50 | } 51 | 52 | public void OnPackageSelectionChange(UnityEditor.PackageManager.PackageInfo packageInfo) 53 | { 54 | if (packageInfo == this.packageInfo) 55 | return; 56 | this.packageInfo = packageInfo; 57 | this.packagePath = System.IO.Path.GetFullPath(packageInfo.assetPath); 58 | } 59 | 60 | public void OnPackageAddedOrUpdated(UnityEditor.PackageManager.PackageInfo packageInfo) { } 61 | public void OnPackageRemoved(UnityEditor.PackageManager.PackageInfo packageInfo) { } 62 | 63 | static DocGeneratorPackageMangerExtension() 64 | { 65 | PackageManagerExtensions.RegisterExtension(new DocGeneratorPackageMangerExtension()); 66 | } 67 | } 68 | } -------------------------------------------------------------------------------- /Editor/PackageManger/DocGeneratorPackageMangerExtension.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 3721346b497924216b6198d4b40dd329 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Editor/Utils.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 61825c77b039c446e94516cd2c235543 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /Editor/Utils/Excuter.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections; 3 | using System.Collections.Generic; 4 | using System.Diagnostics; 5 | using System.IO; 6 | using UnityEngine; 7 | 8 | public static class Excuter 9 | { 10 | static string result = ""; 11 | static string error = ""; 12 | public static (int exitCode, string result, string error) Bash(this string cmd, string workingDirectory = "") 13 | { 14 | 15 | ProcessStartInfo startInfo; 16 | #if UNITY_EDITOR_OSX || UNITY_EDITOR_LINUX 17 | var escapedArgs = cmd.Replace("\"", "\\\""); 18 | 19 | startInfo = new ProcessStartInfo 20 | { 21 | FileName = "/bin/bash", 22 | Arguments = $"-c \"{escapedArgs}\"", 23 | RedirectStandardOutput = true, 24 | RedirectStandardError = true, 25 | UseShellExecute = false, 26 | CreateNoWindow = true, 27 | }; 28 | #elif UNITY_EDITOR_WIN 29 | var escapedArgs = cmd; 30 | 31 | startInfo = new ProcessStartInfo 32 | { 33 | FileName = "cmd.exe", 34 | Arguments = $"/C \"{escapedArgs}\"", 35 | RedirectStandardOutput = true, 36 | RedirectStandardError = true, 37 | UseShellExecute = false, 38 | CreateNoWindow = true, 39 | WorkingDirectory = workingDirectory 40 | }; 41 | #endif 42 | 43 | var process = new Process() 44 | { 45 | StartInfo = startInfo 46 | }; 47 | 48 | 49 | // UnityEngine.Debug.Log(escapedArgs); 50 | process.Start(); 51 | 52 | string line = process.StandardOutput.ReadLine(); 53 | while (line != null) 54 | { 55 | result += line + "\n"; 56 | // UnityEngine.Debug.Log("line:" + line); 57 | line = process.StandardOutput.ReadLine(); 58 | } 59 | string errorLine = process.StandardOutput.ReadLine(); 60 | while (errorLine != null) 61 | { 62 | error += errorLine + "\n"; 63 | // UnityEngine.Debug.Log("line:" + line); 64 | errorLine = process.StandardOutput.ReadLine(); 65 | } 66 | process.WaitForExit(); 67 | return (process.ExitCode, result, error); 68 | } 69 | 70 | //From UnityEditor.PackageManager.DocumentationTools.UI 71 | internal static bool Unzip(string zipFilePath, string destPath) 72 | { 73 | string zipper = Utils.Get7zPath; 74 | string inputArguments = string.Format("x -y -o\"{0}\" \"{1}\"", destPath, zipFilePath); 75 | ProcessStartInfo startInfo = new ProcessStartInfo(); 76 | startInfo.UseShellExecute = false; 77 | startInfo.FileName = zipper; 78 | startInfo.Arguments = inputArguments; 79 | startInfo.RedirectStandardError = true; 80 | var process = Process.Start(startInfo); 81 | process.WaitForExit(); 82 | 83 | if (process.ExitCode != 0) 84 | throw new IOException(string.Format("Failed to unzip:\n{0} {1}\n\n{2}", zipper, inputArguments, process.StandardError.ReadToEnd())); 85 | 86 | return true; 87 | } 88 | 89 | } 90 | -------------------------------------------------------------------------------- /Editor/Utils/Excuter.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: a9f36dbe6acb5481f87df509b7b62a25 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Editor/Utils/SimpleHTTPServer.cs: -------------------------------------------------------------------------------- 1 | //Source from https://github.com/sableangle/UnityHTTPServer 2 | using UnityEngine; 3 | using System.Collections; 4 | using System; 5 | using System.Collections.Generic; 6 | using System.Linq; 7 | using System.Text; 8 | using System.Net.Sockets; 9 | using System.Net; 10 | using System.IO; 11 | using System.Threading; 12 | using System.Diagnostics; 13 | using System.Reflection; 14 | 15 | public class SimpleHTTPServer 16 | { 17 | static int bufferSize = 16; 18 | public System.Object _methodController; 19 | private readonly string[] _indexFiles = 20 | { 21 | "index.html", 22 | "index.htm", 23 | "default.html", 24 | "default.htm" 25 | }; 26 | 27 | private static IDictionary _mimeTypeMappings = new Dictionary(StringComparer.InvariantCultureIgnoreCase) 28 | { 29 | #region extension to MIME type list 30 | { ".asf", "video/x-ms-asf" }, 31 | { ".asx", "video/x-ms-asf" }, 32 | { ".avi", "video/x-msvideo" }, 33 | { ".bin", "application/octet-stream" }, 34 | { ".cco", "application/x-cocoa" }, 35 | { ".crt", "application/x-x509-ca-cert" }, 36 | { ".css", "text/css" }, 37 | { ".deb", "application/octet-stream" }, 38 | { ".der", "application/x-x509-ca-cert" }, 39 | { ".dll", "application/octet-stream" }, 40 | { ".dmg", "application/octet-stream" }, 41 | { ".ear", "application/java-archive" }, 42 | { ".eot", "application/octet-stream" }, 43 | { ".exe", "application/octet-stream" }, 44 | { ".flv", "video/x-flv" }, 45 | { ".gif", "image/gif" }, 46 | { ".hqx", "application/mac-binhex40" }, 47 | { ".htc", "text/x-component" }, 48 | { ".htm", "text/html" }, 49 | { ".html", "text/html" }, 50 | { ".ico", "image/x-icon" }, 51 | { ".img", "application/octet-stream" }, 52 | { ".svg", "image/svg+xml" }, 53 | { ".iso", "application/octet-stream" }, 54 | { ".jar", "application/java-archive" }, 55 | { ".jardiff", "application/x-java-archive-diff" }, 56 | { ".jng", "image/x-jng" }, 57 | { ".jnlp", "application/x-java-jnlp-file" }, 58 | { ".jpeg", "image/jpeg" }, 59 | { ".jpg", "image/jpeg" }, 60 | { ".js", "application/x-javascript" }, 61 | { ".mml", "text/mathml" }, 62 | { ".mng", "video/x-mng" }, 63 | { ".mov", "video/quicktime" }, 64 | { ".mp3", "audio/mpeg" }, 65 | { ".mpeg", "video/mpeg" }, 66 | { ".mp4", "video/mp4" }, 67 | { ".mpg", "video/mpeg" }, 68 | { ".msi", "application/octet-stream" }, 69 | { ".msm", "application/octet-stream" }, 70 | { ".msp", "application/octet-stream" }, 71 | { ".pdb", "application/x-pilot" }, 72 | { ".pdf", "application/pdf" }, 73 | { ".pem", "application/x-x509-ca-cert" }, 74 | { ".pl", "application/x-perl" }, 75 | { ".pm", "application/x-perl" }, 76 | { ".png", "image/png" }, 77 | { ".prc", "application/x-pilot" }, 78 | { ".ra", "audio/x-realaudio" }, 79 | { ".rar", "application/x-rar-compressed" }, 80 | { ".rpm", "application/x-redhat-package-manager" }, 81 | { ".rss", "text/xml" }, 82 | { ".run", "application/x-makeself" }, 83 | { ".sea", "application/x-sea" }, 84 | { ".shtml", "text/html" }, 85 | { ".sit", "application/x-stuffit" }, 86 | { ".swf", "application/x-shockwave-flash" }, 87 | { ".tcl", "application/x-tcl" }, 88 | { ".tk", "application/x-tcl" }, 89 | { ".txt", "text/plain" }, 90 | { ".war", "application/java-archive" }, 91 | { ".wbmp", "image/vnd.wap.wbmp" }, 92 | { ".wmv", "video/x-ms-wmv" }, 93 | { ".xml", "text/xml" }, 94 | { ".xpi", "application/x-xpinstall" }, 95 | { ".zip", "application/zip" }, 96 | #endregion 97 | }; 98 | private Thread _serverThread; 99 | private string _rootDirectory; 100 | private HttpListener _listener; 101 | private int _port; 102 | 103 | public string GetRootDirectory() 104 | { 105 | return _rootDirectory; 106 | } 107 | 108 | public int Port 109 | { 110 | get { return _port; } 111 | private set { } 112 | } 113 | 114 | /// 115 | /// Construct server with given port, path ,controller and buffer. 116 | /// 117 | /// 伺服器 root 的實體路徑 118 | /// Port 開放 http 訪問的 port 119 | /// 處理方法的控制器，邏輯類似 ASP MVC 120 | public SimpleHTTPServer(string path, int port, System.Object mc, int buffer) 121 | { 122 | this._methodController = mc; 123 | this.Initialize(path, port); 124 | } 125 | 126 | /// 127 | /// Construct server with given port, path and buffer. 128 | /// 129 | /// 伺服器 root 的實體路徑 130 | /// Port 開放 http 訪問的 port 131 | public SimpleHTTPServer(string path, int port, int buffer) 132 | { 133 | bufferSize = buffer; 134 | this.Initialize(path, port); 135 | } 136 | 137 | /// 138 | /// Stop Server 139 | /// 140 | public void Stop() 141 | { 142 | _serverThread.Abort(); 143 | _listener.Stop(); 144 | } 145 | 146 | private void Listen() 147 | { 148 | _listener = new HttpListener(); 149 | _listener.Prefixes.Add("http://*:" + _port.ToString() + "/"); 150 | _listener.Start(); 151 | while (true) 152 | { 153 | try 154 | { 155 | HttpListenerContext context = _listener.GetContext(); 156 | Process(context); 157 | } 158 | catch (Exception ex) 159 | { 160 | UnityEngine.Debug.Log(ex); 161 | } 162 | } 163 | } 164 | 165 | private void Process(HttpListenerContext context) 166 | { 167 | string filename = context.Request.Url.AbsolutePath; 168 | filename = filename.Substring(1); 169 | 170 | if (string.IsNullOrEmpty(filename)) 171 | { 172 | foreach (string indexFile in _indexFiles) 173 | { 174 | if (File.Exists(Path.Combine(_rootDirectory, indexFile))) 175 | { 176 | filename = indexFile; 177 | break; 178 | } 179 | } 180 | } 181 | 182 | filename = Path.Combine(_rootDirectory, filename); 183 | 184 | Dictionary namedParameters = new Dictionary(); 185 | if (!string.IsNullOrEmpty(context.Request.Url.Query)) 186 | { 187 | UnityEngine.Debug.Log(context.Request.Url.Query); 188 | var query = context.Request.Url.Query.Replace("?", "").Split('&'); 189 | foreach (var item in query) 190 | { 191 | var t = item.Split('='); 192 | 193 | 194 | namedParameters.Add(t[0], t[1]); 195 | } 196 | } 197 | 198 | var method = TryParseToController(context.Request.Url); 199 | 200 | if (File.Exists(filename)) 201 | { 202 | try 203 | { 204 | context.Response.StatusCode = (int)HttpStatusCode.OK; 205 | Stream input = new FileStream(filename, FileMode.Open); 206 | 207 | //Adding permanent http response headers 208 | string mime; 209 | context.Response.ContentType = _mimeTypeMappings.TryGetValue(Path.GetExtension(filename), out mime) ? mime : "application/octet-stream"; 210 | context.Response.ContentLength64 = input.Length; 211 | context.Response.AddHeader("Date", DateTime.Now.ToString("r")); 212 | context.Response.AddHeader("Last-Modified", System.IO.File.GetLastWriteTime(filename).ToString("r")); 213 | 214 | byte[] buffer = new byte[1024 * bufferSize]; 215 | int nbytes; 216 | while ((nbytes = input.Read(buffer, 0, buffer.Length)) > 0) 217 | context.Response.OutputStream.Write(buffer, 0, nbytes); 218 | input.Close(); 219 | 220 | 221 | context.Response.OutputStream.Flush(); 222 | } 223 | catch (Exception ex) 224 | { 225 | context.Response.StatusCode = (int)HttpStatusCode.InternalServerError; 226 | UnityEngine.Debug.Log(ex); 227 | } 228 | 229 | } 230 | //A ASP.Net MVC like controller route 231 | else if (method != null) 232 | { 233 | context.Response.ContentType = "application/json"; 234 | 235 | object result; 236 | result = method.InvokeWithNamedParameters(_methodController, namedParameters); 237 | if (result == null) 238 | { 239 | result = new VoidResult { msg = "Success" }; 240 | } 241 | #if UseLitJson 242 | string jsonString = LitJson.JsonMapper.ToJson(result); 243 | #else 244 | string jsonString = JsonUtility.ToJson(result); 245 | #endif 246 | byte[] jsonByte = Encoding.UTF8.GetBytes(jsonString); 247 | Stream jsonStream = new MemoryStream(jsonByte); 248 | byte[] buffer = new byte[1024 * bufferSize]; 249 | int nbytes; 250 | while ((nbytes = jsonStream.Read(buffer, 0, buffer.Length)) > 0) 251 | context.Response.OutputStream.Write(buffer, 0, nbytes); 252 | jsonStream.Close(); 253 | context.Response.OutputStream.Flush(); 254 | } 255 | else 256 | { 257 | context.Response.StatusCode = (int)HttpStatusCode.NotFound; 258 | } 259 | 260 | context.Response.OutputStream.Close(); 261 | } 262 | 263 | private void Initialize(string path, int port) 264 | { 265 | this._rootDirectory = path; 266 | this._port = port; 267 | _serverThread = new Thread(this.Listen); 268 | _serverThread.Start(); 269 | } 270 | 271 | System.Reflection.MethodInfo TryParseToController(Uri uri) 272 | { 273 | string methodName = uri.Segments[1].Replace("/", ""); 274 | System.Reflection.MethodInfo method = null; 275 | try 276 | { 277 | method = _methodController.GetType().GetMethod(methodName); 278 | } 279 | catch 280 | { 281 | method = null; 282 | } 283 | 284 | return method; 285 | } 286 | 287 | class VoidResult 288 | { 289 | public string msg; 290 | } 291 | } 292 | 293 | //MethodInfo 可使用具名變數的擴充方法 294 | public static class ReflectionExtensions 295 | { 296 | 297 | public static object InvokeWithNamedParameters(this MethodBase self, object obj, IDictionary namedParameters) 298 | { 299 | return self.Invoke(obj, MapParameters(self, namedParameters)); 300 | } 301 | 302 | public static object[] MapParameters(MethodBase method, IDictionary namedParameters) 303 | { 304 | ParameterInfo[] paramInfos = method.GetParameters().ToArray(); 305 | object[] parameters = new object[paramInfos.Length]; 306 | int index = 0; 307 | foreach (var item in paramInfos) 308 | { 309 | object parameterName; 310 | if (!namedParameters.TryGetValue(item.Name, out parameterName)) 311 | { 312 | parameters[index] = Type.Missing; 313 | index++; 314 | continue; 315 | } 316 | parameters[index] = ObjectCastTypeByParameterInfo(item, parameterName); 317 | index++; 318 | } 319 | return parameters; 320 | } 321 | static object ObjectCastTypeByParameterInfo(ParameterInfo parameterInfo, object value) 322 | { 323 | if (parameterInfo.ParameterType == typeof(int) || 324 | parameterInfo.ParameterType == typeof(System.Int32) || 325 | parameterInfo.ParameterType == typeof(System.Int16) || 326 | parameterInfo.ParameterType == typeof(System.Int64)) 327 | { 328 | return (int)Convert.ChangeType(value, typeof(int)); 329 | } 330 | else 331 | { 332 | return value; 333 | } 334 | 335 | } 336 | } 337 | -------------------------------------------------------------------------------- /Editor/Utils/SimpleHTTPServer.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 962a1ad30496d43ba85827b46b4ceca3 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Editor/Utils/Utils.cs: -------------------------------------------------------------------------------- 1 | using System.Collections; 2 | using System.Collections.Generic; 3 | using UnityEngine; 4 | using System.IO; 5 | using System.Diagnostics; 6 | 7 | public class Utils 8 | { 9 | //From UnityEditor.PackageManager.DocumentationTools.UI 10 | internal static string Get7zPath 11 | { 12 | get 13 | { 14 | #if (UNITY_EDITOR_OSX || UNITY_EDITOR_LINUX) 15 | string execFilename = "7za"; 16 | #else 17 | string execFilename = "7z.exe"; 18 | #endif 19 | string zipper = UnityEditor.EditorApplication.applicationContentsPath + "/Tools/" + execFilename; 20 | if (!File.Exists(zipper)) 21 | throw new FileNotFoundException("Could not find " + zipper); 22 | return zipper; 23 | } 24 | } 25 | 26 | /// 27 | /// A very simple method to get relativepath, only work if two path is base on same root 28 | /// 29 | /// 30 | /// 31 | /// 32 | internal static string GetRelativePath(string path1, string path2) 33 | { 34 | string result = "../"; 35 | var p1 = path1.Split(Path.DirectorySeparatorChar); 36 | var p2 = path2.Split(Path.DirectorySeparatorChar); 37 | for (int i = 0; i < Mathf.Abs(p1.Length - p2.Length); i++) 38 | { 39 | result += "../"; 40 | } 41 | return result; 42 | } 43 | 44 | // Need to re-create this method since Unity's FileUtil equivalent (with overwrite) is internal only 45 | // From: https://stackoverflow.com/questions/58744/copy-the-entire-contents-of-a-directory-in-c-sharp 46 | public static void DirectoryCopy(string SourcePath, string DestinationPath) 47 | { 48 | //Now Create all of the directories 49 | foreach (string dirPath in Directory.GetDirectories(SourcePath, "*", SearchOption.AllDirectories)) 50 | Directory.CreateDirectory(dirPath.Replace(SourcePath, DestinationPath)); 51 | 52 | //Copy all the files & Replaces any files with the same name 53 | foreach (string newPath in Directory.GetFiles(SourcePath, "*.*", SearchOption.AllDirectories)) 54 | File.Copy(newPath, newPath.Replace(SourcePath, DestinationPath), true); 55 | } 56 | 57 | public static void DirectoryCopy(string sourceDirName, string destDirName, bool copySubDirs) 58 | { 59 | // Get the subdirectories for the specified directory. 60 | DirectoryInfo dir = new DirectoryInfo(sourceDirName); 61 | 62 | if (!dir.Exists) 63 | { 64 | throw new DirectoryNotFoundException( 65 | "Source directory does not exist or could not be found: " 66 | + sourceDirName); 67 | } 68 | 69 | DirectoryInfo[] dirs = dir.GetDirectories(); 70 | 71 | // If the destination directory doesn't exist, create it. 72 | Directory.CreateDirectory(destDirName); 73 | 74 | // Get the files in the directory and copy them to the new location. 75 | FileInfo[] files = dir.GetFiles(); 76 | foreach (FileInfo file in files) 77 | { 78 | string tempPath = Path.Combine(destDirName, file.Name); 79 | file.CopyTo(tempPath, false); 80 | } 81 | 82 | // If copying subdirectories, copy them and their contents to new location. 83 | if (copySubDirs) 84 | { 85 | foreach (DirectoryInfo subdir in dirs) 86 | { 87 | string tempPath = Path.Combine(destDirName, subdir.Name); 88 | DirectoryCopy(subdir.FullName, tempPath, copySubDirs); 89 | } 90 | } 91 | } 92 | 93 | // public static string GetGeneratorPath() 94 | // { 95 | // "Packages/com.macacagames.docgenerator/"; 96 | // } 97 | } 98 | -------------------------------------------------------------------------------- /Editor/Utils/Utils.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 1898370bea2624240a03d72a226855b5 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Img~/01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Img~/01.png -------------------------------------------------------------------------------- /Img~/01.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: d4086786475cb42239e83c45954973ff 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /Img~/02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Img~/02.png -------------------------------------------------------------------------------- /Img~/02.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 80598c1b6ca924051affa361ac99d16f 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /Img~/03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Img~/03.png -------------------------------------------------------------------------------- /Img~/03.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 7847c54a654c045f4bffae36b14672c8 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /Img~/04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Img~/04.png -------------------------------------------------------------------------------- /Img~/04.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 11637a2da22ce46a9869b0b19927e5af 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /Img~/05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Img~/05.png -------------------------------------------------------------------------------- /Img~/05.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 1c054a67a65b64eb7b0801886b834811 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /Img~/06.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Img~/06.png -------------------------------------------------------------------------------- /Img~/06.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 5a966fead125245fb83437c667c340d2 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /Img~/07.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Img~/07.png -------------------------------------------------------------------------------- /Img~/07.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: f3f19c31541be40329ea659cbe331b23 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # UnityDocGenerator 2 | A helper to make docfx based document in Unity3D 3 | 4 | ## Features 5 | - Document generate based on [Docfx](https://github.com/dotnet/docfx) in Unity3D 6 | - Generate document depend on Unity [Assembly definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html) (.asmdef) files. 7 | - Document web preview hosting in Unity3D. 8 | - Tested on Windows Editor, OSX Editor. 9 | 10 | ## Pre-requisites 11 | UnityDocGenerator require the package manager ui extension mechanism, which is available from version 1.9.3 or later, or remove PackageManager/DocGeneratorPackageManagerExtension.cs to break the Package Manger UI supportion. 12 | ## Installtion 13 | Add the following line to Packages/manifest.json: (or add #{versionCode} in the end of string to use specified version) 14 | ```json 15 | "com.macacagames.docgenerator": "https://github.com/MacacaGames/UnityDocGenerator.git", 16 | ``` 17 | 18 | ### Environment Setup 19 | #### macOS, Linux 20 | Make sure Mono Framework runtime is installed in your computer. 21 | [Download Here](https://www.mono-project.com/download/stable/) 22 | #### Windows 23 | Make sure MSBuild >= 1.5 is installed in your computer. 24 | One of the easiest way is Install the Visual Studio >= 2013. 25 | [Get Visual Studio](https://visualstudio.microsoft.com/zh-hant/downloads/) 26 | 27 | ## Getting Started 28 | ### 1. Open Editor 29 | 30 | - Option 1 (recommend): You can press the **Open with Unity Doc Generator** button on an installed packages to open the UnityDocGenerator. 31 | 32 | 33 | 34 | - Option 2: In Project window you can use Assets Menu to open a folder directly by click **Open with Unity Doc Generator** (This method may not work corrrectly if the folder name contains the "." char) 35 | 36 | 37 | 38 | - Option 3: Open the editor via Unity's toolbar, MacacaGames > UnityDocGenerator 39 | 40 | ### 2. Get the full path of your mono install. 41 | macOS, Linux only! Windows user can skip this step. 42 | 43 | ```bash 44 | which mono 45 | ``` 46 | If the Mono Framework is install correctlly, you may got the return like this. 47 | ```bash 48 | /Library/Frameworks/Mono.framework/Versions/Current/Commands/mono 49 | ``` 50 | Then paste the value to the Mono Path field on Editor. 51 | 52 | 53 | 54 | ### 3. Select your working folder 55 | Type the working folder path or use **Select Folder** select via dialog. 56 | (If the Editor is open via Option 1. or Option 2. the value will fill-up automatically) 57 | 58 | 59 | 60 | UnityDocGenerator will find out all Unity [Assembly definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html) (.asmdef) files inside the folder (include all sub folder) as the DocFx target. 61 | 62 | For example, the screeshot shows there will be 2 files set to DocFx target. 63 | 64 | 65 | 66 | ### 4. Generate!! 67 | Click **Generate Document** and wait for the task complete. 68 | The Unity Editor may hangs during the docfx runing, it is normal and usually resume in 1 min (Based on your project size). 69 | 70 | You can see the DocFx result in Unity Editor Console. 71 | 72 | 73 | 74 | ### 5. Hosting and preview (Optional) 75 | You can preview you generated document via UnityDocGenerator. 76 | Click **Start Hosting** to enable hosting, navigate to http://127.0.0.1:18080/index to view your generated document. 77 | 78 | Hosgint power by [sableangle/UnityHTTPServer](https://github.com/sableangle/UnityHTTPServer) 79 | 80 | 81 | 82 | ### 6. Next Step? 83 | Upload your document to your web server. 84 | The generated html document is in ``/docs~`` folder 85 | 86 | ## Project Struction 87 | UnityDocGenerator will generate two folders in your working folder. 88 | Only modify them if you understand what you're doing, eg.. more custom modify for docfx. 89 | 90 | UnityDocGenerator use .docfx_project/docfx.json as the DocFx setting to generate document. 91 | 92 | ``` 93 | ─ root (The working folder you select) 94 | └─ /your sub folders... 95 | └─ your files... 96 | └─ /.docfx_project (The DocFx project generate by UnityDocGenerator) 97 | └─ docfx.json (DocFx setting file) 98 | └─ other docfx project files... 99 | └─ /docs~ (The generated html document) 100 | └─ /Documentation~ (The generated document) 101 | └─ udg_setting.json (The UnityDocGenerator setting file) 102 | ``` 103 | 104 | ## Customize 105 | You can make your change on DocFx project. The DocFx project is under "{ProjectRoot}/.docfx_project" folder. 106 | See DocFx document for more detail to modify. 107 | 108 | 109 | ## Troubleshooting 110 | - Try to find the error message in Unity Editor Console. 111 | - Make sure you Mono Framework is install correctlly. 112 | - Open an issue on Github if there is any bug, and provide the project which reproduce the issue (if possiable). 113 | - Linux Editor is supported in theory but not tested. 114 | 115 | ## TODO 116 | - More custom setting for docfx. 117 | 118 | 119 | -------------------------------------------------------------------------------- /Readme.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 0fc8a4fe59b5a41c28293cb5f60f295a 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /Tools~/docfx.7z: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/Tools~/docfx.7z -------------------------------------------------------------------------------- /Tools~/docfx.7z.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 8093c842549fc4405af04f8ebd56dbcb 3 | DefaultImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /docs~/Img~/01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/Img~/01.png -------------------------------------------------------------------------------- /docs~/Img~/01.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: d4086786475cb42239e83c45954973ff 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /docs~/Img~/02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/Img~/02.png -------------------------------------------------------------------------------- /docs~/Img~/02.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 80598c1b6ca924051affa361ac99d16f 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /docs~/Img~/03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/Img~/03.png -------------------------------------------------------------------------------- /docs~/Img~/03.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 7847c54a654c045f4bffae36b14672c8 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /docs~/Img~/04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/Img~/04.png -------------------------------------------------------------------------------- /docs~/Img~/04.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 11637a2da22ce46a9869b0b19927e5af 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /docs~/Img~/05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/Img~/05.png -------------------------------------------------------------------------------- /docs~/Img~/05.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 1c054a67a65b64eb7b0801886b834811 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /docs~/Img~/06.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/Img~/06.png -------------------------------------------------------------------------------- /docs~/Img~/06.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 5a966fead125245fb83437c667c340d2 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /docs~/Img~/07.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/Img~/07.png -------------------------------------------------------------------------------- /docs~/Img~/07.png.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: f3f19c31541be40329ea659cbe331b23 3 | TextureImporter: 4 | internalIDToNameTable: [] 5 | externalObjects: {} 6 | serializedVersion: 11 7 | mipmaps: 8 | mipMapMode: 0 9 | enableMipMap: 1 10 | sRGBTexture: 1 11 | linearTexture: 0 12 | fadeOut: 0 13 | borderMipMap: 0 14 | mipMapsPreserveCoverage: 0 15 | alphaTestReferenceValue: 0.5 16 | mipMapFadeDistanceStart: 1 17 | mipMapFadeDistanceEnd: 3 18 | bumpmap: 19 | convertToNormalMap: 0 20 | externalNormalMap: 0 21 | heightScale: 0.25 22 | normalMapFilter: 0 23 | isReadable: 0 24 | streamingMipmaps: 0 25 | streamingMipmapsPriority: 0 26 | grayScaleToAlpha: 0 27 | generateCubemap: 6 28 | cubemapConvolution: 0 29 | seamlessCubemap: 0 30 | textureFormat: 1 31 | maxTextureSize: 2048 32 | textureSettings: 33 | serializedVersion: 2 34 | filterMode: -1 35 | aniso: -1 36 | mipBias: -100 37 | wrapU: -1 38 | wrapV: -1 39 | wrapW: -1 40 | nPOTScale: 1 41 | lightmap: 0 42 | compressionQuality: 50 43 | spriteMode: 0 44 | spriteExtrude: 1 45 | spriteMeshType: 1 46 | alignment: 0 47 | spritePivot: {x: 0.5, y: 0.5} 48 | spritePixelsToUnits: 100 49 | spriteBorder: {x: 0, y: 0, z: 0, w: 0} 50 | spriteGenerateFallbackPhysicsShape: 1 51 | alphaUsage: 1 52 | alphaIsTransparency: 0 53 | spriteTessellationDetail: -1 54 | textureType: 0 55 | textureShape: 1 56 | singleChannelComponent: 0 57 | maxTextureSizeSet: 0 58 | compressionQualitySet: 0 59 | textureFormatSet: 0 60 | applyGammaDecoding: 0 61 | platformSettings: 62 | - serializedVersion: 3 63 | buildTarget: DefaultTexturePlatform 64 | maxTextureSize: 2048 65 | resizeAlgorithm: 0 66 | textureFormat: -1 67 | textureCompression: 1 68 | compressionQuality: 50 69 | crunchedCompression: 0 70 | allowsAlphaSplitting: 0 71 | overridden: 0 72 | androidETC2FallbackOverride: 0 73 | forceMaximumCompressionQuality_BC6H_BC7: 0 74 | spriteSheet: 75 | serializedVersion: 2 76 | sprites: [] 77 | outline: [] 78 | physicsShape: [] 79 | bones: [] 80 | spriteID: 81 | internalID: 0 82 | vertices: [] 83 | indices: 84 | edges: [] 85 | weights: [] 86 | secondaryTextures: [] 87 | spritePackingTag: 88 | pSDRemoveMatte: 0 89 | pSDShowRemoveMatteOption: 0 90 | userData: 91 | assetBundleName: 92 | assetBundleVariant: 93 | -------------------------------------------------------------------------------- /docs~/api/MacacaGames.DocGenerator.Content.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Class Content 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 | 29 | 52 | 53 |
54 | 59 |
60 |
61 |
62 | 63 |
64 | 65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | 73 | 74 |

Class Content 75 |

76 |
77 |
78 |
79 |
Inheritance
80 |
System.Object
81 |
Content
82 |
83 |
84 |
Inherited Members
85 |
86 | System.Object.Equals(System.Object) 87 |
88 |
89 | System.Object.Equals(System.Object, System.Object) 90 |
91 |
92 | System.Object.GetHashCode() 93 |
94 |
95 | System.Object.GetType() 96 |
97 |
98 | System.Object.MemberwiseClone() 99 |
100 |
101 | System.Object.ReferenceEquals(System.Object, System.Object) 102 |
103 |
104 | System.Object.ToString() 105 |
106 |
107 |
Namespace: MacacaGames.DocGenerator
108 |
Assembly: Macaca.DocGenerator.dll
109 |
Syntax
110 |
111 | 
[Serializable]
112 | public class Content
113 |
114 |

Fields 115 |

116 | 117 | | 118 | Improve this Doc 119 | 120 | 121 | View Source 122 | 123 |

files

124 |
125 |
126 |
Declaration
127 |
128 | 
public List<string> files
129 |
130 |
Field Value
131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 |
TypeDescription
System.Collections.Generic.List<System.String>
145 | 146 | | 147 | Improve this Doc 148 | 149 | 150 | View Source 151 | 152 |

src

153 |
154 |
155 |
Declaration
156 |
157 | 
public string src
158 |
159 |
Field Value
160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 |
TypeDescription
System.String
174 |
175 |
176 | 177 | 195 |
196 |
197 | 198 |
199 |
200 |
201 |
202 | 203 | Back to top 204 | 205 | 206 | Generated by DocFX 207 |
208 |
209 |
210 |
211 | 212 | 213 | 214 | 215 | 216 | 217 | -------------------------------------------------------------------------------- /docs~/api/MacacaGames.DocGenerator.DocFxSetting.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Class DocFxSetting 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 | 29 | 52 | 53 |
54 | 59 |
60 |
61 |
62 | 63 |
64 | 65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | 73 | 74 |

Class DocFxSetting 75 |

76 |

Docfx json model

77 |
78 |
79 |
80 |
Inheritance
81 |
System.Object
82 |
DocFxSetting
83 |
84 |
85 |
Inherited Members
86 |
87 | System.Object.Equals(System.Object) 88 |
89 |
90 | System.Object.Equals(System.Object, System.Object) 91 |
92 |
93 | System.Object.GetHashCode() 94 |
95 |
96 | System.Object.GetType() 97 |
98 |
99 | System.Object.MemberwiseClone() 100 |
101 |
102 | System.Object.ReferenceEquals(System.Object, System.Object) 103 |
104 |
105 | System.Object.ToString() 106 |
107 |
108 |
Namespace: MacacaGames.DocGenerator
109 |
Assembly: Macaca.DocGenerator.dll
110 |
Syntax
111 |
112 | 
[Serializable]
113 | public class DocFxSetting
114 |
115 |

Fields 116 |

117 | 118 | | 119 | Improve this Doc 120 | 121 | 122 | View Source 123 | 124 |

build

125 |
126 |
127 |
Declaration
128 |
129 | 
public Build build
130 |
131 |
Field Value
132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 |
TypeDescription
Build
146 | 147 | | 148 | Improve this Doc 149 | 150 | 151 | View Source 152 | 153 |

metadata

154 |
155 |
156 |
Declaration
157 |
158 | 
public List<Metadata> metadata
159 |
160 |
Field Value
161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 |
TypeDescription
System.Collections.Generic.List<Metadata>
175 |
176 |
177 | 178 | 196 |
197 |
198 | 199 |
200 |
201 |
202 |
203 | 204 | Back to top 205 | 206 | 207 | Generated by DocFX 208 |
209 |
210 |
211 |
212 | 213 | 214 | 215 | 216 | 217 | 218 | -------------------------------------------------------------------------------- /docs~/api/MacacaGames.DocGenerator.Overwrite.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Class Overwrite 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 | 29 | 52 | 53 |
54 | 59 |
60 |
61 |
62 | 63 |
64 | 65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | 73 | 74 |

Class Overwrite 75 |

76 |
77 |
78 |
79 |
Inheritance
80 |
System.Object
81 |
Overwrite
82 |
83 |
84 |
Inherited Members
85 |
86 | System.Object.Equals(System.Object) 87 |
88 |
89 | System.Object.Equals(System.Object, System.Object) 90 |
91 |
92 | System.Object.GetHashCode() 93 |
94 |
95 | System.Object.GetType() 96 |
97 |
98 | System.Object.MemberwiseClone() 99 |
100 |
101 | System.Object.ReferenceEquals(System.Object, System.Object) 102 |
103 |
104 | System.Object.ToString() 105 |
106 |
107 |
Namespace: MacacaGames.DocGenerator
108 |
Assembly: Macaca.DocGenerator.dll
109 |
Syntax
110 |
111 | 
[Serializable]
112 | public class Overwrite
113 |
114 |

Fields 115 |

116 | 117 | | 118 | Improve this Doc 119 | 120 | 121 | View Source 122 | 123 |

exclude

124 |
125 |
126 |
Declaration
127 |
128 | 
public List<string> exclude
129 |
130 |
Field Value
131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 |
TypeDescription
System.Collections.Generic.List<System.String>
145 | 146 | | 147 | Improve this Doc 148 | 149 | 150 | View Source 151 | 152 |

files

153 |
154 |
155 |
Declaration
156 |
157 | 
public List<string> files
158 |
159 |
Field Value
160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 |
TypeDescription
System.Collections.Generic.List<System.String>
174 |
175 |
176 | 177 | 195 |
196 |
197 | 198 |
199 |
200 |
201 |
202 | 203 | Back to top 204 | 205 | 206 | Generated by DocFX 207 |
208 |
209 |
210 |
211 | 212 | 213 | 214 | 215 | 216 | 217 | -------------------------------------------------------------------------------- /docs~/api/MacacaGames.DocGenerator.Resource.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Class Resource 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 | 29 | 52 | 53 |
54 | 59 |
60 |
61 |
62 | 63 |
64 | 65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | 73 | 74 |

Class Resource 75 |

76 |
77 |
78 |
79 |
Inheritance
80 |
System.Object
81 |
Resource
82 |
83 |
84 |
Inherited Members
85 |
86 | System.Object.Equals(System.Object) 87 |
88 |
89 | System.Object.Equals(System.Object, System.Object) 90 |
91 |
92 | System.Object.GetHashCode() 93 |
94 |
95 | System.Object.GetType() 96 |
97 |
98 | System.Object.MemberwiseClone() 99 |
100 |
101 | System.Object.ReferenceEquals(System.Object, System.Object) 102 |
103 |
104 | System.Object.ToString() 105 |
106 |
107 |
Namespace: MacacaGames.DocGenerator
108 |
Assembly: Macaca.DocGenerator.dll
109 |
Syntax
110 |
111 | 
[Serializable]
112 | public class Resource
113 |
114 |

Fields 115 |

116 | 117 | | 118 | Improve this Doc 119 | 120 | 121 | View Source 122 | 123 |

files

124 |
125 |
126 |
Declaration
127 |
128 | 
public List<string> files
129 |
130 |
Field Value
131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 |
TypeDescription
System.Collections.Generic.List<System.String>
145 | 146 | | 147 | Improve this Doc 148 | 149 | 150 | View Source 151 | 152 |

src

153 |
154 |
155 |
Declaration
156 |
157 | 
public string src
158 |
159 |
Field Value
160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 |
TypeDescription
System.String
174 |
175 |
176 | 177 | 195 |
196 |
197 | 198 |
199 |
200 |
201 |
202 | 203 | Back to top 204 | 205 | 206 | Generated by DocFX 207 |
208 |
209 |
210 |
211 | 212 | 213 | 214 | 215 | 216 | 217 | -------------------------------------------------------------------------------- /docs~/api/MacacaGames.DocGenerator.Src.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Class Src 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 | 29 | 52 | 53 |
54 | 59 |
60 |
61 |
62 | 63 |
64 | 65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | 73 | 74 |

Class Src 75 |

76 |
77 |
78 |
79 |
Inheritance
80 |
System.Object
81 |
Src
82 |
83 |
84 |
Inherited Members
85 |
86 | System.Object.Equals(System.Object) 87 |
88 |
89 | System.Object.Equals(System.Object, System.Object) 90 |
91 |
92 | System.Object.GetHashCode() 93 |
94 |
95 | System.Object.GetType() 96 |
97 |
98 | System.Object.MemberwiseClone() 99 |
100 |
101 | System.Object.ReferenceEquals(System.Object, System.Object) 102 |
103 |
104 | System.Object.ToString() 105 |
106 |
107 |
Namespace: MacacaGames.DocGenerator
108 |
Assembly: Macaca.DocGenerator.dll
109 |
Syntax
110 |
111 | 
[Serializable]
112 | public class Src
113 |
114 |

Fields 115 |

116 | 117 | | 118 | Improve this Doc 119 | 120 | 121 | View Source 122 | 123 |

files

124 |
125 |
126 |
Declaration
127 |
128 | 
public List<string> files
129 |
130 |
Field Value
131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 |
TypeDescription
System.Collections.Generic.List<System.String>
145 | 146 | | 147 | Improve this Doc 148 | 149 | 150 | View Source 151 | 152 |

src

153 |
154 |
155 |
Declaration
156 |
157 | 
public string src
158 |
159 |
Field Value
160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 |
TypeDescription
System.String
174 |
175 |
176 | 177 | 195 |
196 |
197 | 198 |
199 |
200 |
201 |
202 | 203 | Back to top 204 | 205 | 206 | Generated by DocFX 207 |
208 |
209 |
210 |
211 | 212 | 213 | 214 | 215 | 216 | 217 | -------------------------------------------------------------------------------- /docs~/api/MacacaGames.DocGenerator.VersionDefine.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Class VersionDefine 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 | 29 | 52 | 53 |
54 | 59 |
60 |
61 |
62 | 63 |
64 | 65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | 73 | 74 |

Class VersionDefine 75 |

76 |
77 |
78 |
79 |
Inheritance
80 |
System.Object
81 |
VersionDefine
82 |
83 |
84 |
Inherited Members
85 |
86 | System.Object.Equals(System.Object) 87 |
88 |
89 | System.Object.Equals(System.Object, System.Object) 90 |
91 |
92 | System.Object.GetHashCode() 93 |
94 |
95 | System.Object.GetType() 96 |
97 |
98 | System.Object.MemberwiseClone() 99 |
100 |
101 | System.Object.ReferenceEquals(System.Object, System.Object) 102 |
103 |
104 | System.Object.ToString() 105 |
106 |
107 |
Namespace: MacacaGames.DocGenerator
108 |
Assembly: Macaca.DocGenerator.dll
109 |
Syntax
110 |
111 | 
[Serializable]
112 | public class VersionDefine
113 |
114 |

Fields 115 |

116 | 117 | | 118 | Improve this Doc 119 | 120 | 121 | View Source 122 | 123 |

define

124 |
125 |
126 |
Declaration
127 |
128 | 
public string define
129 |
130 |
Field Value
131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 |
TypeDescription
System.String
145 | 146 | | 147 | Improve this Doc 148 | 149 | 150 | View Source 151 | 152 |

expression

153 |
154 |
155 |
Declaration
156 |
157 | 
public string expression
158 |
159 |
Field Value
160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 |
TypeDescription
System.String
174 | 175 | | 176 | Improve this Doc 177 | 178 | 179 | View Source 180 | 181 |

name

182 |
183 |
184 |
Declaration
185 |
186 | 
[SerializeField]
187 | public string name
188 |
189 |
Field Value
190 | 191 | 192 | 193 | 194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 |
TypeDescription
System.String
204 |
205 |
206 | 207 | 225 |
226 |
227 | 228 |
229 |
230 |
231 |
232 | 233 | Back to top 234 | 235 | 236 | Generated by DocFX 237 |
238 |
239 |
240 |
241 | 242 | 243 | 244 | 245 | 246 | 247 | -------------------------------------------------------------------------------- /docs~/api/MacacaGames.DocGenerator.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Namespace MacacaGames.DocGenerator 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 | 29 | 52 | 53 |
54 | 59 |
60 |
61 |
62 | 63 |
64 | 65 |
66 |
67 |
68 |
69 |
70 |
71 | 105 |
106 | 107 | 119 |
120 |
121 | 122 |
123 |
124 |
125 |
126 | 127 | Back to top 128 | 129 | 130 | Generated by DocFX 131 |
132 |
133 |
134 |
135 | 136 | 137 | 138 | 139 | 140 | 141 | -------------------------------------------------------------------------------- /docs~/api/index.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | Welcome to the Scripting Reference! 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 |
25 |
26 | 27 | 50 | 51 |
52 | 57 |
58 |
59 |
60 | 61 |
62 | 63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |

Welcome to the Scripting Reference!

71 | 72 |

Select the API to view the detail.

73 |
74 |
75 | 76 | 91 |
92 |
93 | 94 |
95 |
96 |
97 |
98 | 99 | Back to top 100 | 101 | 102 | Generated by DocFX 103 |
104 |
105 |
106 |
107 | 108 | 109 | 110 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /docs~/api/toc.html: -------------------------------------------------------------------------------- 1 |  2 |
3 |
4 |
5 |
6 | 7 | 8 | 9 |
10 |
11 |
12 |
13 | 14 | 56 |
57 |
58 |
59 |
-------------------------------------------------------------------------------- /docs~/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/favicon.ico -------------------------------------------------------------------------------- /docs~/fonts/glyphicons-halflings-regular.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/fonts/glyphicons-halflings-regular.eot -------------------------------------------------------------------------------- /docs~/fonts/glyphicons-halflings-regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/fonts/glyphicons-halflings-regular.ttf -------------------------------------------------------------------------------- /docs~/fonts/glyphicons-halflings-regular.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/fonts/glyphicons-halflings-regular.woff -------------------------------------------------------------------------------- /docs~/fonts/glyphicons-halflings-regular.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/fonts/glyphicons-halflings-regular.woff2 -------------------------------------------------------------------------------- /docs~/index.html: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | 6 | 7 | 8 | UnityDocGenerator 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 |
25 |
26 | 27 | 50 | 51 |
52 | 57 |
58 |
59 |
60 |
61 |
62 |
63 |

UnityDocGenerator

64 | 65 |

A helper to make docfx based document in Unity3D

66 |

Features

67 |
    68 |
  • Document generate based on Docfx in Unity3D
    • 69 |
  • Generate document depend on Unity Assembly definitions (.asmdef) files.
    • 70 |
  • Document web preview hosting in Unity3D.
    • 71 |
  • Tested on Windows Editor, OSX Editor.
    • 72 |
73 |

Pre-requisites

74 |

UnityDocGenerator require the package manager ui extension mechanism, which is available from version 1.9.3 or later, or remove PackageManager/DocGeneratorPackageManagerExtension.cs to break the Package Manger UI supportion.

75 |

Installtion

76 |

Add the following line to Packages/manifest.json:

77 | 
"com.macacagames.docgenerator": "https://github.com/MacacaGames/UnityDocGenerator.git#1.0.0",
 78 |
79 |

Environment Setup

80 |

macOS, Linux

81 |

Make sure Mono Framework runtime is installed in your computer. 82 | Download Here

83 |

Windows

84 |

Make sure MSBuild >= 1.5 is installed in your computer. 85 | One of the easiest way is Install the Visual Studio >= 2013. 86 | Get Visual Studio

87 |

Getting Started

88 |

1. Open Editor

89 |
    90 |
  • Option 1 (recommend): You can press the Open with Unity Doc Generator button on an installed packages to open the UnityDocGenerator.
    • 91 |
92 | 93 |
    94 |
  • Option 2: In Project window you can use Assets Menu to open a folder directly by click Open with Unity Doc Generator (This method may not work corrrectly if the folder name contains the "." char)
    • 95 |
96 | 97 |
    98 |
  • Option 3: Open the editor via Unity's toolbar, MacacaGames > UnityDocGenerator
    • 99 |
100 |

2. Get the full path of your mono install.

101 |

macOS, Linux only! Windows user can skip this step.

102 | 
which mono
103 |
104 |

If the Mono Framework is install correctlly, you may got the return like this.

105 | 
/Library/Frameworks/Mono.framework/Versions/Current/Commands/mono
106 |
107 |

Then paste the value to the Mono Path field on Editor.

108 | 109 |

3. Select your working folder

110 |

Type the working folder path or use Select Folder select via dialog. 111 | (If the Editor is open via Option 1. or Option 2. the value will fill-up automatically)

112 | 113 |

UnityDocGenerator will find out all Unity Assembly definitions (.asmdef) files inside the folder (include all sub folder) as the DocFx target.

114 |

For example, the screeshot shows there will be 2 files set to DocFx target.

115 | 116 |

4. Generate!!

117 |

Click Generate Document and wait for the task complete. 118 | The Unity Editor may hangs during the docfx runing, it is normal and usually resume in 1 min (Based on your project size).

119 |

You can see the DocFx result in Unity Editor Console.

120 | 121 |

5. Hosting and preview (Optional)

122 |

You can preview you generated document via UnityDocGenerator. 123 | Click Start Hosting to enable hosting, navigate to http://127.0.0.1:18080/index to view your generated document.

124 |

Hosgint power by sableangle/UnityHTTPServer

125 | 126 |

6. Next Step?

127 |

Upload your document to your web server. 128 | The generated html document is in /docs~ folder

129 |

Project Struction

130 |

UnityDocGenerator will generate two folders in your working folder. 131 | Only modify them if you understand what you're doing, eg.. more custom modify for docfx.

132 |

UnityDocGenerator use .docfx_project/docfx.json as the DocFx setting to generate document.

133 | 
 ─ root (The working folder you select)
134 |   └─ /your sub folders...
135 |   └─ your files...
136 |   └─ /.docfx_project (The DocFx project generate by UnityDocGenerator)
137 |     └─ docfx.json (DocFx setting file)
138 |     └─ other docfx project files...
139 |   └─ /docs~ (The generated html document)
140 |   └─ /Documentation~ (The generated document)
141 |   └─ udg_setting.json (The UnityDocGenerator setting file)
142 |
143 |

Customize

144 |

You can make your change on DocFx project. The DocFx project is under "{ProjectRoot}/.docfx_project" folder. 145 | See DocFx document for more detail to modify.

146 |

Troubleshooting

147 |
    148 |
  • Try to find the error message in Unity Editor Console.
    • 149 |
  • Make sure you Mono Framework is install correctlly.
    • 150 |
  • Open an issue on Github if there is any bug, and provide the project which reproduce the issue (if possiable).
    • 151 |
  • Linux Editor is supported in theory but not tested.
    • 152 |
153 |

TODO

154 |
    155 |
  • More custom setting for docfx.
    • 156 |
157 |
158 |
159 | 160 | 175 |
176 |
177 | 178 |
179 |
180 |
181 |
182 | 183 | Back to top 184 | 185 | 186 | Generated by DocFX 187 |
188 |
189 |
190 |
191 | 192 | 193 | 194 | 195 | 196 | 197 | -------------------------------------------------------------------------------- /docs~/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /docs~/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "homepages": [], 3 | "source_base_path": "/Users/miki/Documents/SquidBeat/SB_Unity/Packages/DocGenerator/.docfx_project", 4 | "xrefmap": "xrefmap.yml", 5 | "files": [ 6 | { 7 | "type": "ManagedReference", 8 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.AsmdefFile.yml", 9 | "output": { 10 | ".html": { 11 | "relative_path": "api/MacacaGames.DocGenerator.AsmdefFile.html", 12 | "hash": "q9faY5YU+lpAOStUhMi/HQ==" 13 | } 14 | }, 15 | "is_incremental": true, 16 | "version": "" 17 | }, 18 | { 19 | "type": "ManagedReference", 20 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.Build.yml", 21 | "output": { 22 | ".html": { 23 | "relative_path": "api/MacacaGames.DocGenerator.Build.html", 24 | "hash": "QWLyea9o4vbZlbwgef5LuQ==" 25 | } 26 | }, 27 | "is_incremental": true, 28 | "version": "" 29 | }, 30 | { 31 | "type": "ManagedReference", 32 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.Content.yml", 33 | "output": { 34 | ".html": { 35 | "relative_path": "api/MacacaGames.DocGenerator.Content.html", 36 | "hash": "UXehq0xDiEvZHuSTB/Lljw==" 37 | } 38 | }, 39 | "is_incremental": true, 40 | "version": "" 41 | }, 42 | { 43 | "type": "ManagedReference", 44 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.DocFxSetting.yml", 45 | "output": { 46 | ".html": { 47 | "relative_path": "api/MacacaGames.DocGenerator.DocFxSetting.html", 48 | "hash": "qxVvcBOaOpvbAmXcgLATCw==" 49 | } 50 | }, 51 | "is_incremental": true, 52 | "version": "" 53 | }, 54 | { 55 | "type": "ManagedReference", 56 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.yml", 57 | "output": { 58 | ".html": { 59 | "relative_path": "api/MacacaGames.DocGenerator.DocGeneratorPackageMangerExtension.html", 60 | "hash": "D+UYxTmkTrDV/6kXSYSKKA==" 61 | } 62 | }, 63 | "is_incremental": true, 64 | "version": "" 65 | }, 66 | { 67 | "type": "ManagedReference", 68 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.DocGeneratorWindow.yml", 69 | "output": { 70 | ".html": { 71 | "relative_path": "api/MacacaGames.DocGenerator.DocGeneratorWindow.html", 72 | "hash": "f5ZabdOmQCs9tFR2F7MjrA==" 73 | } 74 | }, 75 | "is_incremental": true, 76 | "version": "" 77 | }, 78 | { 79 | "type": "ManagedReference", 80 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.Metadata.yml", 81 | "output": { 82 | ".html": { 83 | "relative_path": "api/MacacaGames.DocGenerator.Metadata.html", 84 | "hash": "Ca0Iduh4/GRuWMC6ATRqVw==" 85 | } 86 | }, 87 | "is_incremental": true, 88 | "version": "" 89 | }, 90 | { 91 | "type": "ManagedReference", 92 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.Overwrite.yml", 93 | "output": { 94 | ".html": { 95 | "relative_path": "api/MacacaGames.DocGenerator.Overwrite.html", 96 | "hash": "cVXC0UYVt2UeLNFJBVvW7w==" 97 | } 98 | }, 99 | "is_incremental": true, 100 | "version": "" 101 | }, 102 | { 103 | "type": "ManagedReference", 104 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.Resource.yml", 105 | "output": { 106 | ".html": { 107 | "relative_path": "api/MacacaGames.DocGenerator.Resource.html", 108 | "hash": "vlgtX17yFS2hfsxC/qVIew==" 109 | } 110 | }, 111 | "is_incremental": true, 112 | "version": "" 113 | }, 114 | { 115 | "type": "ManagedReference", 116 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.Src.yml", 117 | "output": { 118 | ".html": { 119 | "relative_path": "api/MacacaGames.DocGenerator.Src.html", 120 | "hash": "6SrRsHDgUay2Xz+1m3fLlA==" 121 | } 122 | }, 123 | "is_incremental": true, 124 | "version": "" 125 | }, 126 | { 127 | "type": "ManagedReference", 128 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.VersionDefine.yml", 129 | "output": { 130 | ".html": { 131 | "relative_path": "api/MacacaGames.DocGenerator.VersionDefine.html", 132 | "hash": "vwoaXn2ltTk7yLhls7xW8Q==" 133 | } 134 | }, 135 | "is_incremental": true, 136 | "version": "" 137 | }, 138 | { 139 | "type": "ManagedReference", 140 | "source_relative_path": "../Documentation~/api/MacacaGames.DocGenerator.yml", 141 | "output": { 142 | ".html": { 143 | "relative_path": "api/MacacaGames.DocGenerator.html", 144 | "hash": "uSq0UnyJCIoePVYwHiic3A==" 145 | } 146 | }, 147 | "is_incremental": true, 148 | "version": "" 149 | }, 150 | { 151 | "type": "Toc", 152 | "source_relative_path": "../Documentation~/api/toc.yml", 153 | "output": { 154 | ".html": { 155 | "relative_path": "api/toc.html", 156 | "hash": "oS+ly3k9XGZbN1pViAPoGg==" 157 | } 158 | }, 159 | "is_incremental": false, 160 | "version": "" 161 | }, 162 | { 163 | "type": "Conceptual", 164 | "source_relative_path": "api/index.md", 165 | "output": { 166 | ".html": { 167 | "relative_path": "api/index.html", 168 | "hash": "azwABIBW3BTUe3ceGKrkZA==" 169 | } 170 | }, 171 | "is_incremental": true, 172 | "version": "" 173 | }, 174 | { 175 | "type": "Resource", 176 | "source_relative_path": "favicon.ico", 177 | "output": { 178 | "resource": { 179 | "relative_path": "favicon.ico" 180 | } 181 | }, 182 | "is_incremental": false, 183 | "version": "" 184 | }, 185 | { 186 | "log_codes": [ 187 | "InvalidFileLink" 188 | ], 189 | "type": "Conceptual", 190 | "source_relative_path": "index.md", 191 | "output": { 192 | ".html": { 193 | "relative_path": "index.html", 194 | "hash": "znciIE9HEoMfxFx2zrIiyg==" 195 | } 196 | }, 197 | "is_incremental": false, 198 | "version": "" 199 | }, 200 | { 201 | "type": "Resource", 202 | "source_relative_path": "logo.svg", 203 | "output": { 204 | "resource": { 205 | "relative_path": "logo.svg" 206 | } 207 | }, 208 | "is_incremental": false, 209 | "version": "" 210 | }, 211 | { 212 | "type": "Toc", 213 | "source_relative_path": "toc.yml", 214 | "output": { 215 | ".html": { 216 | "relative_path": "toc.html", 217 | "hash": "am/S9vBmE9qrVa4lJLnXaw==" 218 | } 219 | }, 220 | "is_incremental": false, 221 | "version": "" 222 | } 223 | ], 224 | "incremental_info": [ 225 | { 226 | "status": { 227 | "can_incremental": true, 228 | "incrementalPhase": "build", 229 | "total_file_count": 0, 230 | "skipped_file_count": 0 231 | }, 232 | "processors": { 233 | "ConceptualDocumentProcessor": { 234 | "can_incremental": true, 235 | "incrementalPhase": "build", 236 | "total_file_count": 2, 237 | "skipped_file_count": 1 238 | }, 239 | "ManagedReferenceDocumentProcessor": { 240 | "can_incremental": true, 241 | "incrementalPhase": "build", 242 | "total_file_count": 12, 243 | "skipped_file_count": 12 244 | }, 245 | "ResourceDocumentProcessor": { 246 | "can_incremental": false, 247 | "details": "Processor ResourceDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.", 248 | "incrementalPhase": "build", 249 | "total_file_count": 0, 250 | "skipped_file_count": 0 251 | }, 252 | "TocDocumentProcessor": { 253 | "can_incremental": false, 254 | "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.", 255 | "incrementalPhase": "build", 256 | "total_file_count": 0, 257 | "skipped_file_count": 0 258 | } 259 | } 260 | }, 261 | { 262 | "status": { 263 | "can_incremental": true, 264 | "details": "Can support incremental post processing.", 265 | "incrementalPhase": "postProcessing", 266 | "total_file_count": 0, 267 | "skipped_file_count": 0 268 | }, 269 | "processors": {} 270 | } 271 | ], 272 | "version_info": {}, 273 | "groups": [ 274 | { 275 | "xrefmap": "xrefmap.yml" 276 | } 277 | ] 278 | } -------------------------------------------------------------------------------- /docs~/search-stopwords.json: -------------------------------------------------------------------------------- 1 | [ 2 | "a", 3 | "able", 4 | "about", 5 | "across", 6 | "after", 7 | "all", 8 | "almost", 9 | "also", 10 | "am", 11 | "among", 12 | "an", 13 | "and", 14 | "any", 15 | "are", 16 | "as", 17 | "at", 18 | "be", 19 | "because", 20 | "been", 21 | "but", 22 | "by", 23 | "can", 24 | "cannot", 25 | "could", 26 | "dear", 27 | "did", 28 | "do", 29 | "does", 30 | "either", 31 | "else", 32 | "ever", 33 | "every", 34 | "for", 35 | "from", 36 | "get", 37 | "got", 38 | "had", 39 | "has", 40 | "have", 41 | "he", 42 | "her", 43 | "hers", 44 | "him", 45 | "his", 46 | "how", 47 | "however", 48 | "i", 49 | "if", 50 | "in", 51 | "into", 52 | "is", 53 | "it", 54 | "its", 55 | "just", 56 | "least", 57 | "let", 58 | "like", 59 | "likely", 60 | "may", 61 | "me", 62 | "might", 63 | "most", 64 | "must", 65 | "my", 66 | "neither", 67 | "no", 68 | "nor", 69 | "not", 70 | "of", 71 | "off", 72 | "often", 73 | "on", 74 | "only", 75 | "or", 76 | "other", 77 | "our", 78 | "own", 79 | "rather", 80 | "said", 81 | "say", 82 | "says", 83 | "she", 84 | "should", 85 | "since", 86 | "so", 87 | "some", 88 | "than", 89 | "that", 90 | "the", 91 | "their", 92 | "them", 93 | "then", 94 | "there", 95 | "these", 96 | "they", 97 | "this", 98 | "tis", 99 | "to", 100 | "too", 101 | "twas", 102 | "us", 103 | "wants", 104 | "was", 105 | "we", 106 | "were", 107 | "what", 108 | "when", 109 | "where", 110 | "which", 111 | "while", 112 | "who", 113 | "whom", 114 | "why", 115 | "will", 116 | "with", 117 | "would", 118 | "yet", 119 | "you", 120 | "your" 121 | ] 122 | -------------------------------------------------------------------------------- /docs~/styles/main.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MacacaGames/UnityDocGenerator/67cbd485f77f7f3b91c02839ccce0eb61020474b/docs~/styles/main.css -------------------------------------------------------------------------------- /docs~/styles/main.js: -------------------------------------------------------------------------------- 1 | // Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. 2 | -------------------------------------------------------------------------------- /docs~/styles/search-worker.js: -------------------------------------------------------------------------------- 1 | (function () { 2 | importScripts('lunr.min.js'); 3 | 4 | var lunrIndex; 5 | 6 | var stopWords = null; 7 | var searchData = {}; 8 | 9 | lunr.tokenizer.separator = /[\s\-\.\(\)]+/; 10 | 11 | var stopWordsRequest = new XMLHttpRequest(); 12 | stopWordsRequest.open('GET', '../search-stopwords.json'); 13 | stopWordsRequest.onload = function () { 14 | if (this.status != 200) { 15 | return; 16 | } 17 | stopWords = JSON.parse(this.responseText); 18 | buildIndex(); 19 | } 20 | stopWordsRequest.send(); 21 | 22 | var searchDataRequest = new XMLHttpRequest(); 23 | 24 | searchDataRequest.open('GET', '../index.json'); 25 | searchDataRequest.onload = function () { 26 | if (this.status != 200) { 27 | return; 28 | } 29 | searchData = JSON.parse(this.responseText); 30 | 31 | buildIndex(); 32 | 33 | postMessage({ e: 'index-ready' }); 34 | } 35 | searchDataRequest.send(); 36 | 37 | onmessage = function (oEvent) { 38 | var q = oEvent.data.q; 39 | var hits = lunrIndex.search(q); 40 | var results = []; 41 | hits.forEach(function (hit) { 42 | var item = searchData[hit.ref]; 43 | results.push({ 'href': item.href, 'title': item.title, 'keywords': item.keywords }); 44 | }); 45 | postMessage({ e: 'query-ready', q: q, d: results }); 46 | } 47 | 48 | function buildIndex() { 49 | if (stopWords !== null && !isEmpty(searchData)) { 50 | lunrIndex = lunr(function () { 51 | this.pipeline.remove(lunr.stopWordFilter); 52 | this.ref('href'); 53 | this.field('title', { boost: 50 }); 54 | this.field('keywords', { boost: 20 }); 55 | 56 | for (var prop in searchData) { 57 | if (searchData.hasOwnProperty(prop)) { 58 | this.add(searchData[prop]); 59 | } 60 | } 61 | 62 | var docfxStopWordFilter = lunr.generateStopWordFilter(stopWords); 63 | lunr.Pipeline.registerFunction(docfxStopWordFilter, 'docfxStopWordFilter'); 64 | this.pipeline.add(docfxStopWordFilter); 65 | this.searchPipeline.add(docfxStopWordFilter); 66 | }); 67 | } 68 | } 69 | 70 | function isEmpty(obj) { 71 | if(!obj) return true; 72 | 73 | for (var prop in obj) { 74 | if (obj.hasOwnProperty(prop)) 75 | return false; 76 | } 77 | 78 | return true; 79 | } 80 | })(); 81 | -------------------------------------------------------------------------------- /docs~/toc.html: -------------------------------------------------------------------------------- 1 |  2 |
3 |
4 |
5 |
6 | 7 | 8 | 9 |
10 |
11 |
12 |
13 | 14 | 19 |
20 |
21 |
22 |
-------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "com.macacagames.docgenerator", 3 | "version": "1.0.2", 4 | "displayName": "Macaca Doc Generator", 5 | "description": "A helper to make docfx based document in Unity3D", 6 | "unity": "2019.4", 7 | "dependencies": {}, 8 | "keywords": [], 9 | "author": { 10 | "name": "Macaca Games", 11 | "email": "contact@macaca.games", 12 | "url": "https://macaca.games" 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /package.json.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 844eaf0b5c6cc4a1da15129572414981 3 | PackageManifestImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /udg_setting.json: -------------------------------------------------------------------------------- 1 | {"copyReadmeToDocfxIndex":true,"disableDefaultFilter":false,"disableGitFeatures":false,"copyFolderToDocument":["/Img~"]} -------------------------------------------------------------------------------- /udg_setting.json.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: a1c1326f80be349cdbe7bbcb6c2f0164 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | --------------------------------------------------------------------------------