Skip to content

Commit 6f90306

Browse files
abeigiabeigi
authored
Merge pull request #3 from qoherent/deploy
nojekyll and broken links
2 parents bfa6818 + ae5a1da commit 6f90306

File tree

2 files changed

+188
-65
lines changed

2 files changed

+188
-65
lines changed

‎docusaurus.config.js‎

Lines changed: 37 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
11
// @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
2+
// Note: type annotations allow type checking and IDEs autocompletion
63

7-
import {themes as prismThemes} from 'prism-react-renderer';
8-
9-
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
4+
const lightCodeTheme = require('prism-react-renderer/themes/github');
5+
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
106

117
/** @type {import('@docusaurus/types').Config} */
128
const config = {
13-
title: 'RIA Docs',
14-
tagline: 'Dinosaurs are cool',
9+
title: 'RIA Hub Documentation',
10+
tagline: 'AI development platform for software-defined radio',
1511
favicon: 'img/favicon.ico',
1612

1713
// Set the production url of your site here
18-
url: 'https://your-docusaurus-site.example.com',
14+
url: 'https://qoherent.github.io',
1915
// Set the /<baseUrl>/ pathname under which your site is served
20-
// For GitHub pages deployment, it is often '/<projectName>/'
21-
baseUrl: '/',
16+
baseUrl: '/ria-hub-docs/',
2217

23-
// GitHub pages deployment config.
24-
// If you aren't using GitHub pages, you don't need these.
25-
organizationName: 'facebook', // Usually your GitHub org/user name.
26-
projectName: 'docusaurus', // Usually your repo name.
18+
// GitHub pages deployment config
19+
organizationName: 'qoherent',
20+
projectName: 'ria-hub-docs',
2721

28-
onBrokenLinks: 'throw',
22+
// CRITICAL: Handle broken links gracefully
23+
onBrokenLinks: 'warn', // Change from 'throw' to 'warn'
2924
onBrokenMarkdownLinks: 'warn',
3025

31-
// Even if you don't use internationalization, you can use this field to set
32-
// useful metadata like html lang. For example, if your site is Chinese, you
33-
// may want to replace "en" with "zh-Hans".
26+
// Even if you don't use internalization, you can use this field to set useful
27+
// metadata like html lang. For example, if your site is Chinese, you may want
28+
// to replace "en" with "zh-Hans".
3429
i18n: {
3530
defaultLocale: 'en',
3631
locales: ['en'],
@@ -42,29 +37,17 @@ const config = {
4237
/** @type {import('@docusaurus/preset-classic').Options} */
4338
({
4439
docs: {
45-
sidebarPath: './sidebars.js',
40+
sidebarPath: require.resolve('./sidebars.js'),
4641
// Please change this to your repo.
47-
// Remove this to remove the "edit this page" links.
48-
editUrl:
49-
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
42+
editUrl: 'https://github.com/qoherent/ria-hub-docs/tree/main/',
5043
},
5144
blog: {
5245
showReadingTime: true,
53-
feedOptions: {
54-
type: ['rss', 'atom'],
55-
xslt: true,
56-
},
5746
// Please change this to your repo.
58-
// Remove this to remove the "edit this page" links.
59-
editUrl:
60-
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
61-
// Useful options to enforce blogging best practices
62-
onInlineTags: 'warn',
63-
onInlineAuthors: 'warn',
64-
onUntruncatedBlogPosts: 'warn',
47+
editUrl: 'https://github.com/qoherent/ria-hub-docs/tree/main/',
6548
},
6649
theme: {
67-
customCss: './src/css/custom.css',
50+
customCss: require.resolve('./src/css/custom.css'),
6851
},
6952
}),
7053
],
@@ -76,24 +59,24 @@ const config = {
7659
// Replace with your project's social card
7760
image: 'img/docusaurus-social-card.jpg',
7861
navbar: {
79-
title: 'RIA Docs',
62+
title: 'RIA Hub',
8063
logo: {
81-
alt: 'Ria docs Logo',
82-
src: 'img/ria.svg',
64+
alt: 'RIA Hub Logo',
65+
src: 'img/logo.svg',
8366
},
8467
items: [
8568
{
8669
type: 'docSidebar',
8770
sidebarId: 'tutorialSidebar',
8871
position: 'left',
89-
label: 'Docs',
72+
label: 'Documentation',
73+
},
74+
{to: '/blog', label: 'Blog', position: 'left'},
75+
{
76+
href: 'https://github.com/qoherent/ria-hub-docs',
77+
label: 'GitHub',
78+
position: 'right',
9079
},
91-
// {to: '/blog', label: 'Blog', position: 'left'},
92-
// {
93-
// href: 'https://github.com/facebook/docusaurus',
94-
// label: 'GitHub',
95-
// position: 'right',
96-
// },
9780
],
9881
},
9982
footer: {
@@ -103,25 +86,17 @@ const config = {
10386
title: 'Docs',
10487
items: [
10588
{
106-
label: 'Tutorial',
107-
to: '/docs/intro',
89+
label: 'Documentation',
90+
to: '/docs/content/search',
10891
},
10992
],
11093
},
11194
{
11295
title: 'Community',
11396
items: [
11497
{
115-
label: 'Stack Overflow',
116-
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
117-
},
118-
{
119-
label: 'Discord',
120-
href: 'https://discordapp.com/invite/docusaurus',
121-
},
122-
{
123-
label: 'X',
124-
href: 'https://x.com/docusaurus',
98+
label: 'GitHub',
99+
href: 'https://github.com/qoherent/ria-hub-docs',
125100
},
126101
],
127102
},
@@ -133,19 +108,16 @@ const config = {
133108
to: '/blog',
134109
},
135110
{
136-
label: 'GitHub',
137-
href: 'https://github.com/facebook/docusaurus',
111+
label: 'Qoherent',
112+
href: 'https://qoherent.ai',
138113
},
139114
],
140115
},
141116
],
142-
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
143117
},
144118
prism: {
145-
theme: prismThemes.github,
146-
darkTheme: prismThemes.dracula,
119+
theme: lightCodeTheme,
120+
darkTheme: darkCodeTheme,
147121
},
148122
}),
149123
};
150-
151-
export default config;

‎docusaurus.config.js_backup‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
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+
7+
import {themes as prismThemes} from 'prism-react-renderer';
8+
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 = {
13+
title: 'RIA Docs',
14+
tagline: 'Dinosaurs are cool',
15+
favicon: 'img/favicon.ico',
16+
17+
// Set the production url of your site here
18+
url: 'https://your-docusaurus-site.example.com',
19+
// Set the /<baseUrl>/ pathname under which your site is served
20+
// For GitHub pages deployment, it is often '/<projectName>/'
21+
baseUrl: '/',
22+
23+
// GitHub pages deployment config.
24+
// If you aren't using GitHub pages, you don't need these.
25+
organizationName: 'facebook', // Usually your GitHub org/user name.
26+
projectName: 'docusaurus', // Usually your repo name.
27+
28+
onBrokenLinks: 'throw',
29+
onBrokenMarkdownLinks: 'warn',
30+
31+
// Even if you don't use internationalization, you can use this field to set
32+
// useful metadata like html lang. For example, if your site is Chinese, you
33+
// may want to replace "en" with "zh-Hans".
34+
i18n: {
35+
defaultLocale: 'en',
36+
locales: ['en'],
37+
},
38+
39+
presets: [
40+
[
41+
'classic',
42+
/** @type {import('@docusaurus/preset-classic').Options} */
43+
({
44+
docs: {
45+
sidebarPath: './sidebars.js',
46+
// Please change this to your repo.
47+
// Remove this to remove the "edit this page" links.
48+
editUrl:
49+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
50+
},
51+
blog: {
52+
showReadingTime: true,
53+
feedOptions: {
54+
type: ['rss', 'atom'],
55+
xslt: true,
56+
},
57+
// Please change this to your repo.
58+
// Remove this to remove the "edit this page" links.
59+
editUrl:
60+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
61+
// Useful options to enforce blogging best practices
62+
onInlineTags: 'warn',
63+
onInlineAuthors: 'warn',
64+
onUntruncatedBlogPosts: 'warn',
65+
},
66+
theme: {
67+
customCss: './src/css/custom.css',
68+
},
69+
}),
70+
],
71+
],
72+
73+
themeConfig:
74+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
75+
({
76+
// Replace with your project's social card
77+
image: 'img/docusaurus-social-card.jpg',
78+
navbar: {
79+
title: 'RIA Docs',
80+
logo: {
81+
alt: 'Ria docs Logo',
82+
src: 'img/ria.svg',
83+
},
84+
items: [
85+
{
86+
type: 'docSidebar',
87+
sidebarId: 'tutorialSidebar',
88+
position: 'left',
89+
label: 'Docs',
90+
},
91+
// {to: '/blog', label: 'Blog', position: 'left'},
92+
// {
93+
// href: 'https://github.com/facebook/docusaurus',
94+
// label: 'GitHub',
95+
// position: 'right',
96+
// },
97+
],
98+
},
99+
footer: {
100+
style: 'dark',
101+
links: [
102+
{
103+
title: 'Docs',
104+
items: [
105+
{
106+
label: 'Tutorial',
107+
to: '/docs/intro',
108+
},
109+
],
110+
},
111+
{
112+
title: 'Community',
113+
items: [
114+
{
115+
label: 'Stack Overflow',
116+
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
117+
},
118+
{
119+
label: 'Discord',
120+
href: 'https://discordapp.com/invite/docusaurus',
121+
},
122+
{
123+
label: 'X',
124+
href: 'https://x.com/docusaurus',
125+
},
126+
],
127+
},
128+
{
129+
title: 'More',
130+
items: [
131+
{
132+
label: 'Blog',
133+
to: '/blog',
134+
},
135+
{
136+
label: 'GitHub',
137+
href: 'https://github.com/facebook/docusaurus',
138+
},
139+
],
140+
},
141+
],
142+
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
143+
},
144+
prism: {
145+
theme: prismThemes.github,
146+
darkTheme: prismThemes.dracula,
147+
},
148+
}),
149+
};
150+
151+
export default config;

0 commit comments

Comments
 (0)