From dfaf382fbff6101c48600ba58f26940775e80661 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20P=C4=99czek?= Date: Mon, 21 Aug 2017 21:57:52 +0200 Subject: [PATCH] DocFx Project (#4) --- .gitignore | 5 ++ CHANGELOG.md | 2 +- .../DocFx.AspNetCore.ServerSentEvents.csproj | 16 ++++++ DocFx.AspNetCore.ServerSentEvents/Program.cs | 10 ++++ .../Properties/launchSettings.json | 27 ++++++++++ DocFx.AspNetCore.ServerSentEvents/Startup.cs | 18 +++++++ DocFx.AspNetCore.ServerSentEvents/docfx.json | 48 ++++++++++++++++++ DocFx.AspNetCore.ServerSentEvents/index.md | 21 ++++++++ .../resources/ico/favicon.ico | Bin 0 -> 198 bytes .../resources/svg/logo.svg | 5 ++ DocFx.AspNetCore.ServerSentEvents/toc.md | 3 ++ Lib.AspNetCore.ServerSentEvents.sln | 11 +++- 12 files changed, 164 insertions(+), 2 deletions(-) create mode 100644 DocFx.AspNetCore.ServerSentEvents/DocFx.AspNetCore.ServerSentEvents.csproj create mode 100644 DocFx.AspNetCore.ServerSentEvents/Program.cs create mode 100644 DocFx.AspNetCore.ServerSentEvents/Properties/launchSettings.json create mode 100644 DocFx.AspNetCore.ServerSentEvents/Startup.cs create mode 100644 DocFx.AspNetCore.ServerSentEvents/docfx.json create mode 100644 DocFx.AspNetCore.ServerSentEvents/index.md create mode 100644 DocFx.AspNetCore.ServerSentEvents/resources/ico/favicon.ico create mode 100644 DocFx.AspNetCore.ServerSentEvents/resources/svg/logo.svg create mode 100644 DocFx.AspNetCore.ServerSentEvents/toc.md diff --git a/.gitignore b/.gitignore index f1e3d20..839938e 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,11 @@ bld/ # Uncomment if you have tasks that create the project's static files in wwwroot #wwwroot/ +# DocFX generated stuff +DocFx.AspNetCore.ServerSentEvents/log.txt +DocFx.AspNetCore.ServerSentEvents/api/ +DocFx.AspNetCore.ServerSentEvents/wwwroot/ + # MSTest test Results [Tt]est[Rr]esult*/ [Bb]uild[Ll]og.* diff --git a/CHANGELOG.md b/CHANGELOG.md index 9fddb96..74f7e75 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,4 +2,4 @@ ### Bug Fixes - Fix for events not reaching clients when response compression is enabled (.NET Framework). ### Additions and Changes -- Added capabality of sending events to specific clients. \ No newline at end of file +- Added capability of sending events to specific clients. \ No newline at end of file diff --git a/DocFx.AspNetCore.ServerSentEvents/DocFx.AspNetCore.ServerSentEvents.csproj b/DocFx.AspNetCore.ServerSentEvents/DocFx.AspNetCore.ServerSentEvents.csproj new file mode 100644 index 0000000..8c41d6c --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/DocFx.AspNetCore.ServerSentEvents.csproj @@ -0,0 +1,16 @@ + + + netcoreapp2.0 + + + + + + + + + + + + + diff --git a/DocFx.AspNetCore.ServerSentEvents/Program.cs b/DocFx.AspNetCore.ServerSentEvents/Program.cs new file mode 100644 index 0000000..1fd501a --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/Program.cs @@ -0,0 +1,10 @@ +using Microsoft.AspNetCore; +using Microsoft.AspNetCore.Hosting; + +namespace DocFx.AspNetCore.ServerSentEvents +{ + public class Program + { + public static void Main(string[] args) => WebHost.CreateDefaultBuilder(args).UseStartup().Build(); + } +} diff --git a/DocFx.AspNetCore.ServerSentEvents/Properties/launchSettings.json b/DocFx.AspNetCore.ServerSentEvents/Properties/launchSettings.json new file mode 100644 index 0000000..6300883 --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/Properties/launchSettings.json @@ -0,0 +1,27 @@ +{ + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:59833/", + "sslPort": 0 + } + }, + "profiles": { + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "DocFx.AspNetCore.ServerSentEvents": { + "commandName": "Project", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + }, + "applicationUrl": "http://localhost:59834/" + } + } +} diff --git a/DocFx.AspNetCore.ServerSentEvents/Startup.cs b/DocFx.AspNetCore.ServerSentEvents/Startup.cs new file mode 100644 index 0000000..d9d3358 --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/Startup.cs @@ -0,0 +1,18 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.DependencyInjection; + +namespace DocFx.AspNetCore.ServerSentEvents +{ + public class Startup + { + public void ConfigureServices(IServiceCollection services) + { } + + public void Configure(IApplicationBuilder app, IHostingEnvironment env) + { + app.UseDefaultFiles() + .UseStaticFiles(); + } + } +} diff --git a/DocFx.AspNetCore.ServerSentEvents/docfx.json b/DocFx.AspNetCore.ServerSentEvents/docfx.json new file mode 100644 index 0000000..b0cffb0 --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/docfx.json @@ -0,0 +1,48 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "Lib.AspNetCore.ServerSentEvents/Lib.AspNetCore.ServerSentEvents.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": ".." + } + ], + "dest": "api", + "properties": { + "TargetFramework": "netstandard1.6" + } + } + ], + "build": { + "content": [ + { + "files": [ + "api/*.yml", + "toc.md", + "index.md" + ] + } + ], + "resource": [ + { + "files": [ + "resources/svg/logo.svg", + "resources/ico/favicon.ico" + ] + } + ], + "dest": "wwwroot", + "globalMetadata": { + "_appTitle": "Lib.AspNetCore.ServerSentEvents", + "_appFooter": "Copyright © 2017 Tomasz Pęczek", + "_appLogoPath": "resources/svg/logo.svg", + "_appFaviconPath": "resources/ico/favicon.ico", + "_disableBreadcrumb": true, + "_disableAffix": true, + "_disableContribution": true + } + } +} \ No newline at end of file diff --git a/DocFx.AspNetCore.ServerSentEvents/index.md b/DocFx.AspNetCore.ServerSentEvents/index.md new file mode 100644 index 0000000..912600e --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/index.md @@ -0,0 +1,21 @@ +# Lib.AspNetCore.ServerSentEvents + +Lib.AspNetCore.ServerSentEvents is a library which provides Server-Sent Events (SSE) support for ASP.NET Core. + +## Getting Started + +Lib.AspNetCore.ServerSentEvents is available on [NuGet](https://www.nuget.org/packages/Lib.AspNetCore.ServerSentEvents/). + +``` +PM> Install-Package Lib.AspNetCore.ServerSentEvents +``` + +## Demos + +The demo project is available on [GitHub](https://github.com/tpeczek/Demo.AspNetCore.ServerSentEvents). + +## Donating + +Lib.AspNetCore.ServerSentEvents is a personal open source project. If Lib.AspNetCore.ServerSentEvents has been helpful to you, consider donating. Donating helps support Lib.AspNetCore.ServerSentEvents. + +Click here to lend your support to: Lib.AspNetCore.ServerSentEvents and make a donation at pledgie.com ! \ No newline at end of file diff --git a/DocFx.AspNetCore.ServerSentEvents/resources/ico/favicon.ico b/DocFx.AspNetCore.ServerSentEvents/resources/ico/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..85a4d9fac03ba838f37feca9d583478bd4afd647 GIT binary patch literal 198 xcmZQzU<5(|0VXiLfq{WR42U&=SOAC>fEXkX0u5jillcGtKc*mwA|N9u!2sz^B%}ZU literal 0 HcmV?d00001 diff --git a/DocFx.AspNetCore.ServerSentEvents/resources/svg/logo.svg b/DocFx.AspNetCore.ServerSentEvents/resources/svg/logo.svg new file mode 100644 index 0000000..c1fcb62 --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/resources/svg/logo.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/DocFx.AspNetCore.ServerSentEvents/toc.md b/DocFx.AspNetCore.ServerSentEvents/toc.md new file mode 100644 index 0000000..b66a53b --- /dev/null +++ b/DocFx.AspNetCore.ServerSentEvents/toc.md @@ -0,0 +1,3 @@ +# [Introduction](index.md) + +# [API Reference](api/Lib.AspNetCore.ServerSentEvents.html) \ No newline at end of file diff --git a/Lib.AspNetCore.ServerSentEvents.sln b/Lib.AspNetCore.ServerSentEvents.sln index a6fbcc9..2ab3585 100644 --- a/Lib.AspNetCore.ServerSentEvents.sln +++ b/Lib.AspNetCore.ServerSentEvents.sln @@ -1,10 +1,12 @@  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 -VisualStudioVersion = 15.0.26430.4 +VisualStudioVersion = 15.0.26730.3 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lib.AspNetCore.ServerSentEvents", "Lib.AspNetCore.ServerSentEvents\Lib.AspNetCore.ServerSentEvents.csproj", "{A0373515-C536-4C8E-B7AD-5878F357556A}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocFx.AspNetCore.ServerSentEvents", "DocFx.AspNetCore.ServerSentEvents\DocFx.AspNetCore.ServerSentEvents.csproj", "{10C3D8E6-BED2-4FBE-B1FE-1AB050B7AEC3}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -15,8 +17,15 @@ Global {A0373515-C536-4C8E-B7AD-5878F357556A}.Debug|Any CPU.Build.0 = Debug|Any CPU {A0373515-C536-4C8E-B7AD-5878F357556A}.Release|Any CPU.ActiveCfg = Release|Any CPU {A0373515-C536-4C8E-B7AD-5878F357556A}.Release|Any CPU.Build.0 = Release|Any CPU + {10C3D8E6-BED2-4FBE-B1FE-1AB050B7AEC3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {10C3D8E6-BED2-4FBE-B1FE-1AB050B7AEC3}.Debug|Any CPU.Build.0 = Debug|Any CPU + {10C3D8E6-BED2-4FBE-B1FE-1AB050B7AEC3}.Release|Any CPU.ActiveCfg = Release|Any CPU + {10C3D8E6-BED2-4FBE-B1FE-1AB050B7AEC3}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {91E86DAF-4C0D-4A0C-8BC4-CD4745C8BAFB} + EndGlobalSection EndGlobal