diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..2781f6d --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/docs/api/.gitignore b/docs/api/.gitignore new file mode 100644 index 0000000..f798527 --- /dev/null +++ b/docs/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/articles/index.md b/docs/articles/index.md index e69de29..46a81b7 100644 --- a/docs/articles/index.md +++ b/docs/articles/index.md @@ -0,0 +1,6 @@ +--- +uid: articles-index +title: Index +name: Index +--- +this is a thing \ No newline at end of file diff --git a/docs/articles/internal/getting-started.md b/docs/articles/internal/getting-started.md index 91ec32e..d333a09 100644 --- a/docs/articles/internal/getting-started.md +++ b/docs/articles/internal/getting-started.md @@ -1,6 +1,7 @@ --- uid: articles-internal-getting-started title: Getting Started +name: Getting Started --- # Getting Started diff --git a/docs/articles/internal/index.md b/docs/articles/internal/index.md index 30fc388..0eadbf5 100644 --- a/docs/articles/internal/index.md +++ b/docs/articles/internal/index.md @@ -1,6 +1,7 @@ --- uid: articles-internal-main title: Starnight.Internal +name: Starnight.Internal --- # Starnight.Internal diff --git a/docs/articles/internal/listeners.md b/docs/articles/internal/listeners.md index 189173c..8070c61 100644 --- a/docs/articles/internal/listeners.md +++ b/docs/articles/internal/listeners.md @@ -1,6 +1,7 @@ --- uid: articles-internal-Listeners title: Listeners +name: Listeners --- # Listeners diff --git a/docs/articles/internal/toc.yml b/docs/articles/internal/toc.yml new file mode 100644 index 0000000..258054e --- /dev/null +++ b/docs/articles/internal/toc.yml @@ -0,0 +1,7 @@ +- order: 0 + href: getting-started.md + name: Getting Started +- order: 0 + href: listeners.md + name: Listeners + diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml new file mode 100644 index 0000000..c5c1892 --- /dev/null +++ b/docs/articles/toc.yml @@ -0,0 +1,11 @@ +- order: 0 + href: internal/index.md + name: Starnight.Internal + items: + - order: 0 + href: internal/getting-started.md + name: Getting Started + - order: 0 + href: internal/listeners.md + name: Listeners + diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..6c61095 --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,71 @@ +{ + "metadata": [ + { + "src": [ + { + "src": "../", + "files": [ + "src/**/bin/**/**/Starnight.dll", + "src/**/bin/**/**/Starnight.Caching.dll", + "src/**/bin/**/**/Starnight.Caching.Providers.dll", + "src/**/bin/**/**/Starnight.Shared.dll", + "src/**/bin/**/**/Starnight.Internal.dll", + "gen/bin/**/**/Starnight.SourceGenerators.dll" + ] + } + ], + "dest": "api", + "includePrivateMembers": false, + "disableGitFeatures": false, + "disableDefaultFilter": false, + "noRestore": false, + "namespaceLayout": "flattened" + } + ], + "build": { + "xrefService": "https://xref.docs.microsoft.com/query?uid={uid}", + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ] + }, + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default" + ], + "postProcessors": [], + "noLangKeyword": false, + "keepFileLink": false + } +} \ No newline at end of file diff --git a/docs/images/toc.yml b/docs/images/toc.yml new file mode 100644 index 0000000..7dd4387 --- /dev/null +++ b/docs/images/toc.yml @@ -0,0 +1,2 @@ +[] + diff --git a/docs/index.md b/docs/index.md index d8fb009..d3f5a12 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1 @@ -this is a thing \ No newline at end of file + diff --git a/docs/src/toc.yml b/docs/src/toc.yml new file mode 100644 index 0000000..7dd4387 --- /dev/null +++ b/docs/src/toc.yml @@ -0,0 +1,2 @@ +[] + diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..c06f5ab --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,5 @@ +- name: Articles + href: articles/ +- name: Api Documentation + href: api/ + homepage: api/index.md