Skip to content

Fix page titles of docs with a notice above the h1 #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MattiasBuelens merged 2 commits into from
Oct 12, 2026
Merged

Fix page titles of docs with a notice above the h1 #910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bab522a
Move h1 above rebranding notice so Docusaurus picks it up as page title
MattiasBuelens Oct 12, 2026
67cf3d6
Throw on doc pages without a title
MattiasBuelens Oct 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import 'dotenv/config';
import { themes as prismThemes } from 'prism-react-renderer';
import type { Config } from '@docusaurus/types';
import { GlobExcludeDefault } from '@docusaurus/utils';
import { GlobExcludeDefault, parseMarkdownContentTitle } from '@docusaurus/utils';
import type * as Preset from '@docusaurus/preset-classic';
import type { ThemeConfig as DocSearchThemeConfig } from '@docsearch/docusaurus-adapter';
import type * as DocsPlugin from '@docusaurus/plugin-content-docs';
Expand Down Expand Up @@ -630,6 +630,12 @@ const config: Config = {
}
frontMatter.sidebar_custom_props ??= { icon: '🚀 ' };
}
if (!frontMatter.title && !path.basename(params.filePath).startsWith('_') && !parseMarkdownContentTitle(result.content).contentTitle) {
// Docusaurus only detects the h1 as the page title if it's at the very top (only imports may come before it)
throw new Error(
`${params.filePath}: Missing page title. Move the h1 heading to the top of the document (above any components such as <RebrandingNotice />), or set a title in the front matter.`
);
}
return result;
},
},
Expand Down
4 changes: 2 additions & 2 deletions millicast/getting-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ sidebar_label: Getting Started
slug: /getting-started
---

# Getting started with OptiView Real-time Streaming

import DocCard from '@theme/DocCard';
import RebrandingNotice from '@site/millicast/callouts/_rebranding_notice.md';

<RebrandingNotice />

# Getting started with OptiView Real-time Streaming

Dolby OptiView's Real-time Streaming makes it easier to globally stream your high-value content with broadcast-quality picture and sound to massive audiences all with subsecond latency. Use this tutorial to quickly set up and run your own private stream and begin building applications for a variety of use cases.

:::tip[OptiView Real-time Account]
Expand Down
4 changes: 2 additions & 2 deletions theolive_versioned_docs/version-v1/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ sidebar_position: 2
sidebar_label: Getting started
---

# Backend

import RebrandingNotice from '@site/theolive_versioned_docs/version-v1/callouts/_rebranding_notice.md';
import V2Notice from '@site/theolive_versioned_docs/version-v1/callouts/_v2_notice.md';

<RebrandingNotice />

<V2Notice />

# Backend

THEOlive provides a REST API to manage channels, configure them and start / stop them. Each possible call can be found at our [API Reference](./api/channels/create-channel.api.mdx).

However, to make things easier for non-developers, we built a management console on top of these API calls which makes it straightforward to perform the basic actions. To be able to create and use a THEOlive channel, you should register for an account and get a token to perform [authenticated requests](./platform/authorization.mdx) to our API.
Expand Down
Loading