Skip to content

Commit

Permalink
DocFx Project (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
tpeczek committed Aug 21, 2017
1 parent 3e2ca88 commit dfaf382
Show file tree
Hide file tree
Showing 12 changed files with 164 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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.*
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- Added capability of sending events to specific clients.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>netcoreapp2.0</TargetFramework>
</PropertyGroup>
<ItemGroup>
<None Remove="log.txt" />
</ItemGroup>
<ItemGroup>
<Folder Include="articles\" />
<Folder Include="wwwroot\" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="docfx.console" Version="2.22.3" />
<PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0" />
</ItemGroup>
</Project>
10 changes: 10 additions & 0 deletions DocFx.AspNetCore.ServerSentEvents/Program.cs
Original file line number Diff line number Diff line change
@@ -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<Startup>().Build();
}
}
27 changes: 27 additions & 0 deletions DocFx.AspNetCore.ServerSentEvents/Properties/launchSettings.json
Original file line number Diff line number Diff line change
@@ -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/"
}
}
}
18 changes: 18 additions & 0 deletions DocFx.AspNetCore.ServerSentEvents/Startup.cs
Original file line number Diff line number Diff line change
@@ -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();
}
}
}
48 changes: 48 additions & 0 deletions DocFx.AspNetCore.ServerSentEvents/docfx.json
Original file line number Diff line number Diff line change
@@ -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
}
}
}
21 changes: 21 additions & 0 deletions DocFx.AspNetCore.ServerSentEvents/index.md
Original file line number Diff line number Diff line change
@@ -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.

<a href='https://pledgie.com/campaigns/33551'><img alt='Click here to lend your support to: Lib.AspNetCore.ServerSentEvents and make a donation at pledgie.com !' src='https://pledgie.com/campaigns/33551.png?skin_name=chrome' border='0' ></a>
Binary file not shown.
5 changes: 5 additions & 0 deletions DocFx.AspNetCore.ServerSentEvents/resources/svg/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions DocFx.AspNetCore.ServerSentEvents/toc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# [Introduction](index.md)

# [API Reference](api/Lib.AspNetCore.ServerSentEvents.html)
11 changes: 10 additions & 1 deletion Lib.AspNetCore.ServerSentEvents.sln
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

0 comments on commit dfaf382

Please sign in to comment.