Skip to content

Commit 1e1c96e

Browse files
committed
add base doc site
1 parent 24160d3 commit 1e1c96e

File tree

15 files changed

+301
-0
lines changed

15 files changed

+301
-0
lines changed

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/_site

docs/api/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml
5+
.manifest

docs/api/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# API Documentation
2+
3+
You can browse the latest jwt.net API Documentation[^1] [here](NATS.Jwt.yml).
4+
5+
[^1]: API Documentation is auto-generated using [DocFX](https://dotnet.github.io/docfx/).

docs/docfx.json

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"files": [ "**/*.csproj" ],
7+
"src": "../src"
8+
}
9+
],
10+
"dest": "api",
11+
"includePrivateMembers": false,
12+
"disableGitFeatures": false,
13+
"disableDefaultFilter": false,
14+
"noRestore": false,
15+
"namespaceLayout": "nested",
16+
"memberLayout": "separatePages",
17+
"allowCompilationErrors": false
18+
}
19+
],
20+
"build": {
21+
"content": [
22+
{
23+
"files": [
24+
"api/**.yml",
25+
"api/index.md"
26+
]
27+
},
28+
{
29+
"files": [
30+
"documentation/**.md",
31+
"documentation/**/toc.yml",
32+
"toc.yml",
33+
"*.md"
34+
]
35+
}
36+
],
37+
"resource": [
38+
{
39+
"files": [
40+
"images/**"
41+
]
42+
}
43+
],
44+
"output": "_site",
45+
"globalMetadataFiles": [],
46+
"fileMetadataFiles": [],
47+
"template": [
48+
"default",
49+
"modern",
50+
"nats_template"
51+
],
52+
"postProcessors": [],
53+
"keepFileLink": false,
54+
"disableGitFeatures": false,
55+
"markdownEngineName": "markdig",
56+
"markdownEngineProperties": {
57+
"markdigExtensions": [
58+
"abbreviations",
59+
"definitionlists",
60+
"tasklists",
61+
"footnotes"
62+
]
63+
}
64+
}
65+
}

docs/documentation/intro.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Introduction
2+
3+
This is a .NET implementation of the JWT library for the NATS ecosystem.
4+
5+
A [JWT](https://jwt.io/) implementation that uses [nkeys](https://github.com/nats-io/nkeys.net) to digitally sign
6+
JWT tokens for the [NATS](https://nats.io/) ecosystem.
7+
8+
See also https://github.com/nats-io/jwt
9+
10+
## Installation
11+
12+
Reference [Jwt.net NuGet package](https://www.nuget.org/packages/jwt.net) in your project:
13+
You can install the package via NuGet:
14+
15+
```bash
16+
dotnet add package NATS.Jwt --prerelease
17+
```
18+
19+
## Usage
20+
21+
[!code-csharp[](../../tests/NATS.Jwt.DocsExamples/IntroPage.cs#nats-jwt)]
22+
23+
24+
## What's Next
25+
26+
*Documentation is in progress.* Help us improve the documentation by contributing today!

docs/documentation/toc.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- name: Introduction
2+
href: intro.md
3+
4+
- name: Updating Documentation
5+
href: update-docs.md

docs/documentation/update-docs.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Updating Documentation
2+
3+
As well as being able to edit pages on GitHub, you can also edit and update this documentation,
4+
view locally and submit a Pull Request to be included in this documentation site.
5+
6+
## Running DocFX locally
7+
8+
You mush have [DocFX installed](https://dotnet.github.io/docfx/):
9+
Clone the jwt.net ([nats-io/jwt.net](https://github.com/nats-io/jwt.net)) repository, then `cd docs` and run local server (`docfx --serve`) to view this documentation site.
10+
11+
```
12+
dotnet tool update -g docfx
13+
```
14+
15+
Generate API documentation and run local server:
16+
```
17+
git clone https://github.com/nats-io/jwt.net.git
18+
cd jwt.net/docs
19+
docfx --serve
20+
```
21+
22+
You might not be a .NET developer, but still want to contribute to the documentation.
23+
You can install the .NET SDK and use the `docfx` tool to generate the documentation.
24+
Download the .NET SDK from [dot.net](https://dot.net).

docs/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Introduction
2+
3+
This is a .NET implementation of the JWT library for the NATS ecosystem.
4+
5+
A [JWT](https://jwt.io/) implementation that uses [nkeys](https://github.com/nats-io/nkeys.net) to digitally sign
6+
JWT tokens for the [NATS](https://nats.io/) ecosystem.
7+
8+
See also https://github.com/nats-io/jwt
9+
10+
## Installation
11+
12+
Reference [Jwt.net NuGet package](https://www.nuget.org/packages/jwt.net) in your project:
13+
You can install the package via NuGet:
14+
15+
```bash
16+
dotnet add package NATS.Jwt --prerelease
17+
```
18+
19+
## Usage
20+
21+
[!code-csharp[](../tests/NATS.Jwt.DocsExamples/IntroPage.cs#nats-jwt)]
22+
23+
24+
## What's Next
25+
26+
*Documentation is in progress.* Help us improve the documentation by contributing today!

docs/nats_template/favicon.ico

1.12 KB
Binary file not shown.

docs/nats_template/logo.svg

Lines changed: 5 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)