@@ -5,152 +5,162 @@ import { themes as prismThemes } from "prism-react-renderer";
55import { DeepPartial } from "utility-types" ;
66
77export type LttleDocusaurusConfig = {
8- url : string ;
9- typesenseServerConfig : Pick <
10- TypesenseThemeConfig [ "typesense" ] [ "typesenseServerConfig" ] ,
11- "nodes" | "apiKey"
12- > ;
8+ url : string ;
9+ typesenseServerConfig : Pick <
10+ TypesenseThemeConfig [ "typesense" ] [ "typesenseServerConfig" ] ,
11+ "nodes" | "apiKey"
12+ > ;
1313} ;
1414
1515export const getConfig = ( cfg : LttleDocusaurusConfig ) : Config => ( {
16- title : "lttle.cloud docs" ,
17- tagline : "no rewrites. no cold starts. no paying for idle." ,
18- favicon : "img/favicon.ico" ,
16+ title : "lttle.cloud docs" ,
17+ tagline : "no rewrites. no cold starts. no paying for idle." ,
18+ favicon : "img/favicon.ico" ,
19+ customFields : {
20+ brandTitleParts : {
21+ lttle : "lttle" ,
22+ dot : "." ,
23+ cloud : "cloud" ,
24+ suffix : "docs" ,
25+ taglineHtml :
26+ "no rewrites.<br /> no cold starts.<br /> no paying for idle." ,
27+ } ,
28+ } ,
1929
20- // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
21- future : {
22- v4 : true , // Improve compatibility with the upcoming Docusaurus v4
23- } ,
30+ // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
31+ future : {
32+ v4 : true , // Improve compatibility with the upcoming Docusaurus v4
33+ } ,
2434
25- // Set the production url of your site here
26- url : cfg . url ,
27- // Set the /<baseUrl>/ pathname under which your site is served
28- // For GitHub pages deployment, it is often '/<projectName>/'
29- baseUrl : "/" ,
35+ // Set the production url of your site here
36+ url : cfg . url ,
37+ // Set the /<baseUrl>/ pathname under which your site is served
38+ // For GitHub pages deployment, it is often '/<projectName>/'
39+ baseUrl : "/" ,
3040
31- onBrokenLinks : "throw" ,
32- onBrokenMarkdownLinks : "warn" ,
41+ onBrokenLinks : "throw" ,
42+ onBrokenMarkdownLinks : "warn" ,
3343
34- // Even if you don't use internationalization, you can use this field to set
35- // useful metadata like html lang. For example, if your site is Chinese, you
36- // may want to replace "en" with "zh-Hans".
37- i18n : {
38- defaultLocale : "en" ,
39- locales : [ "en" ] ,
40- } ,
44+ // Even if you don't use internationalization, you can use this field to set
45+ // useful metadata like html lang. For example, if your site is Chinese, you
46+ // may want to replace "en" with "zh-Hans".
47+ i18n : {
48+ defaultLocale : "en" ,
49+ locales : [ "en" ] ,
50+ } ,
4151
42- presets : [
43- [
44- "classic" ,
45- {
46- docs : {
47- sidebarPath : "./sidebars.ts" ,
48- editUrl : "https://github.com/lttle-cloud/docs/tree/main" ,
49- } ,
50- theme : {
51- customCss : "./src/css/custom.css" ,
52- } ,
53- } satisfies Preset . Options ,
52+ presets : [
53+ [
54+ "classic" ,
55+ {
56+ docs : {
57+ sidebarPath : "./sidebars.ts" ,
58+ editUrl : "https://github.com/lttle-cloud/docs/tree/main" ,
59+ } ,
60+ theme : {
61+ customCss : "./src/css/custom.css" ,
62+ } ,
63+ } satisfies Preset . Options ,
64+ ] ,
5465 ] ,
55- ] ,
5666
57- themes : [ "docusaurus-theme-search-typesense" ] ,
67+ themes : [ "docusaurus-theme-search-typesense" ] ,
5868
59- themeConfig : {
60- // TODO: Replace with your project's social card
61- image : "img/docusaurus-social-card.jpg" ,
69+ themeConfig : {
70+ // TODO: Replace with your project's social card
71+ image : "img/docusaurus-social-card.jpg" ,
6272
63- colorMode : {
64- respectPrefersColorScheme : true ,
65- } ,
66- navbar : {
67- title : "docs" ,
68- logo : {
69- alt : "lttle docs" ,
70- src : "img/logo.svg" ,
71- srcDark : "img/logo-dark.svg" ,
72- height : 32 ,
73- width : 43 ,
74- } ,
75- items : [
76- {
77- type : "docSidebar" ,
78- sidebarId : "documentationSidebar" ,
79- position : "left" ,
80- label : "Documentation" ,
81- } ,
82- {
83- href : "https://github.com/lttle-cloud/ignition" ,
84- label : "GitHub" ,
85- position : "right" ,
73+ colorMode : {
74+ respectPrefersColorScheme : true ,
8675 } ,
87- ] ,
88- } ,
89- footer : {
90- style : "dark" ,
91- links : [
92- {
93- title : "Docs" ,
94- items : [
95- {
96- label : "Documentation" ,
97- to : "/docs/introduction" ,
76+ navbar : {
77+ title : "docs" ,
78+ logo : {
79+ alt : "lttle docs" ,
80+ src : "img/logo.svg" ,
81+ srcDark : "img/logo-dark.svg" ,
82+ height : 32 ,
83+ width : 43 ,
9884 } ,
99- ] ,
85+ items : [
86+ {
87+ type : "docSidebar" ,
88+ sidebarId : "documentationSidebar" ,
89+ position : "left" ,
90+ label : "Documentation" ,
91+ } ,
92+ {
93+ href : "https://github.com/lttle-cloud/ignition" ,
94+ label : "GitHub" ,
95+ position : "right" ,
96+ } ,
97+ ] ,
10098 } ,
101- {
102- title : "Community" ,
103- items : [
104- {
105- label : "Discord" ,
106- href : "https://discord.gg/xhNGGrZQja" ,
107- } ,
108- {
109- label : "X" ,
110- href : "https://x.com/lttlecloud_" ,
111- } ,
112- ] ,
113- } ,
114- {
115- title : "More" ,
116- items : [
117- {
118- label : "GitHub" ,
119- href : "https://github.com/lttle-cloud/ignition" ,
120- } ,
121- {
122- label : "LinkedIn" ,
123- href : "https://www.linkedin.com/company/lttle-cloud" ,
124- } ,
125- ] ,
99+ footer : {
100+ style : "dark" ,
101+ links : [
102+ {
103+ title : "Docs" ,
104+ items : [
105+ {
106+ label : "Documentation" ,
107+ to : "/docs/introduction" ,
108+ } ,
109+ ] ,
110+ } ,
111+ {
112+ title : "Community" ,
113+ items : [
114+ {
115+ label : "Discord" ,
116+ href : "https://discord.gg/xhNGGrZQja" ,
117+ } ,
118+ {
119+ label : "X" ,
120+ href : "https://x.com/lttlecloud_" ,
121+ } ,
122+ ] ,
123+ } ,
124+ {
125+ title : "More" ,
126+ items : [
127+ {
128+ label : "GitHub" ,
129+ href : "https://github.com/lttle-cloud/ignition" ,
130+ } ,
131+ {
132+ label : "LinkedIn" ,
133+ href : "https://www.linkedin.com/company/lttle-cloud" ,
134+ } ,
135+ ] ,
136+ } ,
137+ ] ,
138+ copyright : `Copyright © ${ new Date ( ) . getFullYear ( ) } lttle cloud. Built with Docusaurus.` ,
126139 } ,
127- ] ,
128- copyright : `Copyright © ${ new Date ( ) . getFullYear ( ) } lttle cloud. Built with Docusaurus.` ,
129- } ,
130- prism : {
131- theme : prismThemes . github ,
132- darkTheme : prismThemes . dracula ,
133- magicComments : [
134- {
135- className : "code-block-error-line" ,
136- line : "code-block-error-line" ,
140+ prism : {
141+ theme : prismThemes . github ,
142+ darkTheme : prismThemes . dracula ,
143+ magicComments : [
144+ {
145+ className : "code-block-error-line" ,
146+ line : "code-block-error-line" ,
147+ } ,
148+ ] ,
137149 } ,
138- ] ,
139- } ,
140- // TypeSense is configured with the same cfg as Algolia
141- // But it uses a different search engine (Typesense)
142- typesense : {
143- typesenseCollectionName : "lttle-cloud-docs" ,
150+ // TypeSense is configured with the same cfg as Algolia
151+ // But it uses a different search engine (Typesense)
152+ typesense : {
153+ typesenseCollectionName : "lttle-cloud-docs" ,
144154
145- typesenseServerConfig : {
146- ...cfg . typesenseServerConfig ,
147- } ,
155+ typesenseServerConfig : {
156+ ...cfg . typesenseServerConfig ,
157+ } ,
148158
149- // Optional: Typesense search parameters: https://typesense.org/docs/0.24.0/api/search.html#search-parameters
150- typesenseSearchParameters : { } ,
159+ // Optional: Typesense search parameters: https://typesense.org/docs/0.24.0/api/search.html#search-parameters
160+ typesenseSearchParameters : { } ,
151161
152- // Optional
153- contextualSearch : true ,
154- } ,
155- } satisfies Preset . ThemeConfig & DeepPartial < TypesenseThemeConfig > ,
162+ // Optional
163+ contextualSearch : true ,
164+ } ,
165+ } satisfies Preset . ThemeConfig & DeepPartial < TypesenseThemeConfig > ,
156166} ) ;
0 commit comments