Skip to content

Commit 427071a

Browse files
alexeyzimarevalexeyzimarev
committed
Updated the docs
1 parent 984086c commit 427071a

25 files changed

+1929
-22824
lines changed

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,5 @@ RestSharp.IntegrationTests/config.json
5252
/node_modules/
5353
/out/
5454
/docs/.vuepress/dist/
55-
.vscode/
55+
.vscode/
56+
.temp/

‎docs/.vuepress/config.js

+66-45
Original file line numberDiff line numberDiff line change
@@ -4,54 +4,75 @@ module.exports = {
44
plugins: ["@vuepress/active-header-links"],
55
themeConfig: {
66
logo: "/restsharp.png",
7-
nav: [
8-
{text: "Get help", link: "/get-help/"},
9-
{text: "Gitter", link: "https://gitter.im/RestSharp/RestSharp"},
7+
navbar: [
8+
{text: "vNext", link: "/v107/"},
9+
{text: "Documentation", link: "/intro.html"},
10+
{text: "Get help", link: "/support/"},
1011
{text: "NuGet", link: "https://nuget.org/packages/RestSharp"}
1112
],
1213
sidebarDepth: 2,
13-
sidebar: [
14-
{
15-
title: "Getting Started",
16-
path: "/getting-started/",
17-
collapsable: false,
18-
children: [
19-
"/getting-started/",
20-
"/getting-started/getting-started"
21-
]
22-
},
23-
{
24-
title: "Using RestSharp",
25-
path: "/usage/",
26-
collapsable: false,
27-
children: [
28-
"/usage/serialization",
29-
"/usage/files",
30-
"/usage/authenticators",
31-
"/usage/parameters",
32-
"/usage/exceptions"
33-
]
34-
},
35-
{
36-
title: "Got stuck?",
37-
path: "/get-help/",
38-
collapsable: false,
39-
children: [
40-
"/get-help/faq"
41-
]
42-
},
43-
{
44-
title: "Reference",
45-
path: "/api/",
46-
collapsable: true,
47-
children: [
48-
"/api/RestSharp",
49-
"/api/RestSharp.Serializers.NewtonsoftJson",
50-
"/api/RestSharp.Serializers.SystemTextJson",
51-
"/api/RestSharp.Serializers.Utf8Json",
52-
]
53-
}
54-
],
14+
sidebar: {
15+
"/": [
16+
{
17+
text: "",
18+
header: "RestSharp",
19+
children: [
20+
"intro.md",
21+
"usage.md",
22+
"authenticators.md"
23+
]
24+
}
25+
],
26+
"/v107/": [
27+
{
28+
text: "",
29+
header: "RestSharp vNext",
30+
children: [
31+
"/v107/README.md"
32+
]
33+
}
34+
],
35+
"/support/": [
36+
{
37+
text: "",
38+
header: "Get help",
39+
children: [
40+
"/support/README.md"
41+
]
42+
}
43+
]
44+
},
45+
// [
46+
// {
47+
// title: "Getting Started",
48+
// path: "/getting-started/",
49+
// collapsable: false,
50+
// children: [
51+
// "/getting-started/",
52+
// "/getting-started/getting-started"
53+
// ]
54+
// },
55+
// {
56+
// title: "Using RestSharp",
57+
// path: "/usage/",
58+
// collapsable: false,
59+
// children: [
60+
// "/usage/serialization",
61+
// "/usage/files",
62+
// "/usage/authenticators",
63+
// "/usage/parameters",
64+
// "/usage/exceptions"
65+
// ]
66+
// },
67+
// {
68+
// title: "Got stuck?",
69+
// path: "/get-help/",
70+
// collapsable: false,
71+
// children: [
72+
// "/get-help/faq"
73+
// ]
74+
// }
75+
// ],
5576
searchPlaceholder: "Search...",
5677
lastUpdated: "Last Updated",
5778
repo: "restsharp/RestSharp",

‎docs/README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,23 @@ home: true
33
heroImage: /restsharp.png
44
heroText: RestSharp
55
tagline: Probably, the most popular REST API client library for .NET
6-
actionText: Get Started →
7-
actionLink: /getting-started/
6+
actions:
7+
- text: Get Started →
8+
link: /intro
89
features:
910
- title: Serialization
1011
details: JSON, XML and custom serialization and deserialization
11-
- title: Sync and Async
12-
details: Variety of overloads to make synchronous and asynchronous HTTP calls
12+
- title: Fully async
13+
details: Variety of overloads to make asynchronous HTTP calls
1314
- title: Extensive configuration
1415
details: Almost every aspect of an HTTP call can be customized
1516
- title: Authentication
16-
details: Basic, OAuth 1, OAuth 2, JWT, NTLM are supported. Not enough? Write your own!
17+
details: Basic, OAuth 1, OAuth 2, and JWT are supported. Not enough? Write your own!
1718
- title: Forms, request body, and files
1819
details: Send objects as the request body in JSON or XML, or as a form. Upload and download files as bytes or as streams.
1920
- title: Parameters
2021
details: Add query, URL segment, body, form or header parameter using an easy and fluent API
21-
footer: Apache 2.0 Licensed | Copyright © 2009-2020 John Sheehan, Andrew Young, Alexey Zimarev and RestSharp community.
22+
footer: Apache 2.0 Licensed | Copyright © 2009-2021 John Sheehan, Andrew Young, Alexey Zimarev and RestSharp community.
2223
---
2324

2425
RestSharp is probably the most popular HTTP client library for .NET. Featuring automatic serialization and deserialization, request and response type detection, variety of authentications and other useful features, it is being used by hundreds of thousands of projects.

‎docs/api/README.md

-18
This file was deleted.

0 commit comments

Comments
 (0)