Skip to content

Commit 12d796f

Browse files
scottoffenscottoffen
committed
Update docusaurus
1 parent 95f58eb commit 12d796f

5 files changed

Lines changed: 135 additions & 116 deletions

File tree

‎docs/docusaurus.config.js‎

Lines changed: 125 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,58 @@
1+
// @ts-check
2+
// `@type` JSDoc annotations allow editor autocompletion and type checking
3+
// (when paired with `@ts-check`).
4+
// There are various equivalent ways to declare your Docusaurus config.
5+
// See: https://docusaurus.io/docs/api/docusaurus-config
6+
17
import { themes as prismThemes } from 'prism-react-renderer';
28

3-
export default {
9+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
10+
11+
/** @type {import('@docusaurus/types').Config} */
12+
const config = {
413
title: 'FluentHttpClient',
514
tagline: 'Use HttpClient with readable and chainable methods.',
15+
favicon: 'img/favicon.ico',
16+
17+
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
18+
future: {
19+
v4: true, // Improve compatibility with the upcoming Docusaurus v4
20+
},
21+
22+
// Set the production url of your site here
623
url: 'https://scottoffen.github.io',
24+
// Set the /<baseUrl>/ pathname under which your site is served
25+
// For GitHub pages deployment, it is often '/<projectName>/'
726
baseUrl: '/fluenthttpclient/',
8-
onBrokenLinks: 'warn',
9-
markdown: {
10-
hooks: {
11-
onBrokenMarkdownLinks: 'warn',
12-
},
13-
},
14-
favicon: 'img/favicon.ico',
15-
trailingSlash: false,
1627

17-
organizationName: 'scottoffen', // GitHub username
18-
projectName: 'fluenthttpclient', // Repo name
28+
// GitHub pages deployment config.
29+
// If you aren't using GitHub pages, you don't need these.
30+
organizationName: 'scottoffen', // Usually your GitHub org/user name.
31+
projectName: 'fluenthttpclient', // Usually your repo name.
1932

33+
onBrokenLinks: 'warn',
34+
35+
// Even if you don't use internationalization, you can use this field to set
36+
// useful metadata like html lang. For example, if your site is Chinese, you
37+
// may want to replace "en" with "zh-Hans".
2038
i18n: {
2139
defaultLocale: 'en',
2240
locales: ['en'],
2341
},
2442

25-
// This enables compatibility with Docusaurus v4 (future-proof)
26-
future: {
27-
v4: true,
28-
},
29-
30-
clientModules: [
31-
require.resolve('./src/clientModules/version-attribute.js'),
32-
],
33-
3443
presets: [
3544
[
3645
'classic',
37-
{
46+
/** @type {import('@docusaurus/preset-classic').Options} */
47+
({
3848
docs: {
3949
routeBasePath: '/', // Serve docs at the root (no /docs prefix)
4050
sidebarPath: './sidebars.js',
41-
editUrl: 'https://github.com/scottoffen/fluenthttpclient/edit/main/docs/',
51+
// Please change this to your repo.
52+
// Remove this to remove the "edit this page" links.
53+
editUrl:
54+
'https://github.com/scottoffen/fluenthttpclient/tree/main/docs/',
55+
4256
lastVersion: 'current', // "current" = whatever is in /docs
4357
versions: {
4458
current: {
@@ -55,99 +69,103 @@ export default {
5569
},
5670
}
5771
},
58-
blog: false, // Disable blog
72+
blog: false,
5973
theme: {
6074
customCss: './src/css/custom.css',
6175
},
62-
},
76+
}),
6377
],
6478
],
6579

66-
themeConfig: {
67-
navbar: {
68-
title: 'FluentHttpClient',
69-
logo: {
70-
alt: 'FluentHttpClient Logo',
71-
src: 'img/logo.svg',
80+
themeConfig:
81+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
82+
({
83+
// Replace with your project's social card
84+
image: 'img/docusaurus-social-card.jpg',
85+
colorMode: {
86+
respectPrefersColorScheme: true,
7287
},
73-
items: [
74-
{
75-
type: 'docSidebar',
76-
sidebarId: 'docsSidebar',
77-
position: 'left',
78-
label: 'Docs',
79-
},
80-
{
81-
type: 'docsVersionDropdown',
82-
position: 'right',
83-
dropdownActiveClassDisabled: true,
84-
},
85-
{
86-
href: 'https://github.com/scottoffen/fluenthttpclient',
87-
label: 'GitHub',
88-
position: 'right',
89-
},
90-
],
91-
},
92-
footer: {
93-
style: 'dark',
94-
links: [
95-
{
96-
title: 'Documentation',
97-
items: [
98-
{
99-
label: 'Getting Started',
100-
to: '/',
101-
},
102-
],
88+
navbar: {
89+
title: 'FluentHttpClient',
90+
logo: {
91+
alt: 'FluentHttpClient Logo',
92+
src: 'img/logo.svg',
10393
},
104-
{
105-
title: 'Community',
106-
items: [
107-
{
108-
label: 'Discussions',
109-
href: 'https://github.com/scottoffen/fluenthttpclient/discussions',
110-
},
111-
{
112-
label: 'Stack Overflow',
113-
href: 'https://stackoverflow.com/questions/tagged/fluenthttpclient',
114-
},
115-
],
116-
},
117-
{
118-
title: 'Project',
119-
items: [
120-
{
121-
label: 'Contributing Guide',
122-
href: 'https://github.com/scottoffen/fluenthttpclient/blob/main/CONTRIBUTING.md',
123-
},
124-
{
125-
label: 'Code of Conduct',
126-
href: 'https://github.com/scottoffen/fluenthttpclient/blob/main/CODE_OF_CONDUCT.md',
127-
},
128-
{
129-
label: 'GitHub',
130-
href: 'https://github.com/scottoffen/fluenthttpclient',
131-
},
132-
],
133-
},
134-
],
135-
copyright: `Copyright © ${new Date().getFullYear()} Scott Offen`,
136-
},
137-
prism: {
138-
theme: prismThemes.github,
139-
darkTheme: prismThemes.dracula,
140-
},
141-
titleDelimiter: '|',
142-
titleTemplate: 'FluentHttpClient | %s'
143-
},
94+
items: [
95+
{
96+
type: 'docSidebar',
97+
sidebarId: 'docsSidebar',
98+
position: 'left',
99+
label: 'Docs',
100+
},
101+
{
102+
type: 'docsVersionDropdown',
103+
position: 'right',
104+
dropdownActiveClassDisabled: true,
105+
},
106+
{
107+
href: 'https://github.com/scottoffen/fluenthttpclient',
108+
label: 'GitHub',
109+
position: 'right',
110+
},
111+
],
112+
},
113+
footer: {
114+
style: 'dark',
115+
links: [
116+
{
117+
title: 'Documentation',
118+
items: [
119+
{
120+
label: 'Getting Started',
121+
to: '/',
122+
},
123+
],
124+
},
125+
{
126+
title: 'Community',
127+
items: [
128+
{
129+
label: 'Discussions',
130+
href: 'https://github.com/scottoffen/fluenthttpclient/discussions',
131+
},
132+
{
133+
label: 'Stack Overflow',
134+
href: 'https://stackoverflow.com/questions/tagged/fluenthttpclient',
135+
},
136+
],
137+
},
138+
{
139+
title: 'Project',
140+
items: [
141+
{
142+
label: 'Contributing Guide',
143+
href: 'https://github.com/scottoffen/fluenthttpclient/blob/main/CONTRIBUTING.md',
144+
},
145+
{
146+
label: 'Code of Conduct',
147+
href: 'https://github.com/scottoffen/fluenthttpclient/blob/main/CODE_OF_CONDUCT.md',
148+
},
149+
{
150+
label: 'GitHub',
151+
href: 'https://github.com/scottoffen/fluenthttpclient',
152+
},
153+
],
154+
},
155+
],
156+
copyright: `Copyright © ${new Date().getFullYear()} Scott Offen`,
157+
},
158+
prism: {
159+
theme: prismThemes.github,
160+
darkTheme: prismThemes.dracula,
161+
},
162+
titleDelimiter: '|',
163+
titleTemplate: 'FluentHttpClient | %s'
164+
}),
144165

145-
scripts: [
146-
{
147-
src: 'https://umami-f0it.onrender.com/script.js',
148-
async: true,
149-
defer: true,
150-
'data-website-id': 'f53d857b-b0e1-44c0-9eea-7ab0bd4a195b',
151-
},
166+
clientModules: [
167+
require.resolve('./src/clientModules/version-attribute.js'),
152168
],
153169
};
170+
171+
export default config;

‎docs/package-lock.json‎

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
"dependencies": {
1717
"@docusaurus/core": "3.10.1",
18-
"@docusaurus/faster": "^3.10.1",
18+
"@docusaurus/faster": "3.10.1",
1919
"@docusaurus/preset-classic": "3.10.1",
2020
"@mdx-js/react": "^3.0.0",
2121
"clsx": "^2.0.0",

‎docs/sidebars.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@
1515
@type {import('@docusaurus/plugin-content-docs').SidebarsConfig}
1616
*/
1717
const sidebars = {
18-
// By default, Docusaurus generates a sidebar from the docs folder structure
1918
docsSidebar: [{type: 'autogenerated', dirName: '.'}],
2019

20+
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
21+
2122
// But you can create a sidebar manually
2223
/*
2324
tutorialSidebar: [

docs/src/pages/markdown-page.md renamed to docs/src/pages/markdown-page.mdx

File renamed without changes.

0 commit comments

Comments
 (0)