Skip to content

Commit 8e90b5a

Browse files
Merge pull request #3 from Listenarrs/feature/adding-site
Fixing styles and documentation accuracy
2 parents 9376c1a + 2720b75 commit 8e90b5a

18 files changed

Lines changed: 1181 additions & 228 deletions

File tree

docs/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: /
55

66
# Listenarr documentation
77

8-
Listenarr is a self-hosted audiobook automation server built to streamline the path from discovery to a clean, organized library. This site covers installation, first-run setup, the main configuration screens, and the bundled API UI.
8+
Listenarr is a self-hosted audiobook automation server built to streamline the path from discovery to a clean, organized library. This site covers installation, first-run setup, the main configuration screens, and the Listenarr API.
99

1010
## What you can do with Listenarr
1111

@@ -29,4 +29,4 @@ Listenarr is a self-hosted audiobook automation server built to streamline the p
2929

3030
## API
3131

32-
Open the bundled [API documentation](/api/) to inspect and test the current OpenAPI document that ships with this docs site.
32+
Open the [API guide](/api/) to review the bundled OpenAPI snapshot and see how to use Swagger on your own Listenarr instance.

docs/product-tour/features.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

docs/reference/api.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/reference/development.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docusaurus.config.js

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,19 @@ const config = {
4545
],
4646
],
4747

48+
themes: [
49+
[
50+
require.resolve('@easyops-cn/docusaurus-search-local'),
51+
{
52+
indexBlog: false,
53+
indexPages: true,
54+
docsRouteBasePath: '/docs',
55+
highlightSearchTermsOnTargetPage: true,
56+
explicitSearchResultPath: true,
57+
},
58+
],
59+
],
60+
4861
themeConfig:
4962
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
5063
({
@@ -67,6 +80,10 @@ const config = {
6780
label: 'API',
6881
position: 'left',
6982
},
83+
{
84+
type: 'search',
85+
position: 'right',
86+
},
7087
{
7188
href: 'https://github.com/Listenarrs/Listenarr',
7289
className: 'header-github-link',

0 commit comments

Comments
 (0)