Skip to content

Commit 7ae9102

Browse files
committed
Attempting to sort docfx page layout & menu
1 parent 86f70dd commit 7ae9102

File tree

8 files changed

+77
-95
lines changed

8 files changed

+77
-95
lines changed

docs/.gitignore

-9
This file was deleted.

docs/api/.gitignore

-5
This file was deleted.

docs/docfx.json

+53-61
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,60 @@
11
{
2-
"metadata": [
3-
{
4-
"src": [
5-
{
6-
"src": "../src",
7-
"files": [
8-
"Rqlite.Client/bin/**/*.dll"
9-
]
10-
}
11-
],
12-
"dest": "api",
13-
"includePrivateMembers": false,
14-
"disableGitFeatures": false,
15-
"disableDefaultFilter": false,
16-
"noRestore": false,
17-
"namespaceLayout": "flattened",
18-
"memberLayout": "separatePages",
19-
"EnumSortOrder": "alphabetic",
20-
"allowCompilationErrors": false
21-
}
22-
],
23-
"build": {
24-
"content": [
25-
{
26-
"files": [
27-
"api/**.yml",
28-
"api/index.md"
29-
]
30-
},
2+
"metadata": [
3+
{
4+
"src": [
315
{
6+
"src": "../src",
327
"files": [
33-
"articles/**.md",
34-
"articles/**/toc.yml",
35-
"toc.yml",
36-
"*.md"
8+
"Rqlite.Client/bin/**/*.dll"
379
]
3810
}
3911
],
40-
"resource": [
41-
{
42-
"files": [
43-
"images/**"
44-
]
45-
}
46-
],
47-
"globalMetadata": {
48-
"_appTitle": "Rqlite",
49-
"_appName": "Rqlite",
50-
"_appFooter": "<span>Copyright (c) 2023-2024 <a href=\"https://bfren.dev\">bfren</a>. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></span>"
51-
},
52-
"sitemap": {
53-
"baseUrl": "https://bfren.github.io/rqlite",
54-
"priority": 0.5,
55-
"changefreq": "daily"
56-
},
57-
"globalMetadataFiles": [],
58-
"fileMetadataFiles": [],
59-
"output": "_site",
60-
"template": [
61-
"default",
62-
"modern"
63-
],
64-
"postProcessors": [],
65-
"keepFileLink": false,
66-
"disableGitFeatures": false
12+
"dest": "api",
13+
"includePrivateMembers": false,
14+
"disableGitFeatures": false,
15+
"disableDefaultFilter": false,
16+
"noRestore": false,
17+
"namespaceLayout": "flattened",
18+
"memberLayout": "separatePages",
19+
"EnumSortOrder": "alphabetic",
20+
"allowCompilationErrors": false
6721
}
68-
}
22+
],
23+
"build": {
24+
"content": [
25+
{
26+
"files": [
27+
"api/**.yml",
28+
"api/index.md"
29+
]
30+
}
31+
],
32+
"resource": [
33+
{
34+
"files": [
35+
"images/**"
36+
]
37+
}
38+
],
39+
"globalMetadata": {
40+
"_appTitle": "Rqlite",
41+
"_appName": "Rqlite",
42+
"_appFooter": "<span>Copyright &copy; 2023-2024 <a href=\"https://bfren.dev\">bfren</a>. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></span>"
43+
},
44+
"sitemap": {
45+
"baseUrl": "https://bfren.github.io/rqlite",
46+
"priority": 0.5,
47+
"changefreq": "daily"
48+
},
49+
"globalMetadataFiles": [],
50+
"fileMetadataFiles": [],
51+
"output": "_site",
52+
"template": [
53+
"default",
54+
"modern"
55+
],
56+
"postProcessors": [],
57+
"keepFileLink": false,
58+
"disableGitFeatures": false
59+
}
60+
}
File renamed without changes.
File renamed without changes.

docs/docs/toc.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- name: Get Started
2+
- href: ../index.md
3+
4+
- name: Essentials
5+
- href: configuration.md
6+
- href: querying.md

docs/index.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,14 @@ This is a community client for accessing [Rqlite](https://rqlite.io) from .NET a
55
## Contents
66

77
* [Installation](#installation)
8-
* [Readme App](#readme-app)
98
* [Usage](#usage)
9+
* [Readme App](#readme-app)
1010
* [Licence / Copyright](#licence)
1111

1212
## Installation
1313

1414
You can either download and build the source yourself in your own project, or install the [NuGet Package](https://nuget.org/packages/rqlite).
1515

16-
## Readme App
17-
18-
To see the library in action, the source contains a Readme App. Simply checkout the repository, spin up a Rqlite instance (Docker required), and run the project:
19-
20-
```bash
21-
# in a temporary directory of your choice
22-
$ git checkout https://github.com/bfren/rqlite .
23-
$ chmod +x run.sh
24-
$ ./run.sh
25-
26-
# in a new terminal
27-
$ dotnet run --project apps/ReadmeApp
28-
```
29-
3016
## Usage
3117

3218
The recommended way to use `Rqlite.Client` is via dependency injection. Support for `Microsoft.Extensions.DependencyInjection` is included, e.g.
@@ -64,6 +50,20 @@ var items = await client.QueryAsync<Item>("SELECT * FROM item WHERE id = :id", n
6450

6551
NB: This client is **async only** so you **must** use it within `async` methods so you can make use of the `await` keyword.
6652

53+
## Readme App
54+
55+
To see the library in action, the source contains a Readme App. Simply checkout the repository, spin up a Rqlite instance (Docker required), and run the project:
56+
57+
```bash
58+
# in a temporary directory of your choice
59+
$ git checkout https://github.com/bfren/rqlite .
60+
$ chmod +x run.sh
61+
$ ./run.sh
62+
63+
# in a new terminal
64+
$ dotnet run --project apps/ReadmeApp
65+
```
66+
6767
## Licence
6868

6969
> [MIT](https://mit.bfren.dev/2023)

docs/toc.yml

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
- name: Get Started
2-
- href: index.md
3-
- href: configuration.md
4-
- href: querying.md
5-
1+
- name: Docs
2+
href: docs/
3+
homepage: docs/configuration.md
64
- name: API
75
href: api/
86
homepage: api/index.md

0 commit comments

Comments
 (0)