Skip to content

Commit 1bf7c3f

Browse files
authored
feat(llms): add tip callout and markdown view support (#1184)
2 parents 58b7cc4 + 37a5a00 commit 1bf7c3f

File tree

4 files changed

+84
-1
lines changed

4 files changed

+84
-1
lines changed

docs/1-intro.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,17 @@ Additional configuration and API resources are detailed on the [Network](/networ
127127

128128
## Build faster with ecosystem tools
129129

130+
:::tip[Building with AI]
131+
132+
To feed Developer Hub into your LLM, use these auto-generated [llms.txt](https://llmstxt.org/) files served from the site root:
133+
134+
- `/llms-full.txt` - The entire documentation as a single text file.
135+
- `/llms.txt` - A concise index of all pages with titles and descriptions.
136+
137+
For specific pages, use the **"View page as Markdown"** button at the bottom of any guide.
138+
139+
:::
140+
130141
<div className="row">
131142
<div className="col col--3 margin-bottom--lg">
132143
<DocCard

docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ const config: Config = {
6262
remarkPlugins: [remarkMath],
6363
rehypePlugins: [rehypeKatex],
6464
editUrl:
65-
"https://github.com/flare-foundation/developer-hub/edit/main",
65+
"https://raw.githubusercontent.com/flare-foundation/developer-hub/main",
6666
onInlineTags: "throw",
6767
},
6868
blog: false,

src/theme/EditThisPage/index.tsx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
import React, { type ReactNode } from "react";
2+
import Translate from "@docusaurus/Translate";
3+
import { ThemeClassNames } from "@docusaurus/theme-common";
4+
import Link from "@docusaurus/Link";
5+
import type { Props } from "@theme/EditThisPage";
6+
import styles from "./styles.module.css";
7+
8+
function ExternalIcon({ className }: { className?: string }) {
9+
return (
10+
<svg
11+
aria-hidden="true"
12+
focusable="false"
13+
xmlns="http://www.w3.org/2000/svg"
14+
width={16}
15+
height={16}
16+
viewBox="0 0 24 24"
17+
fill="none"
18+
stroke="currentColor"
19+
strokeWidth={2}
20+
strokeLinecap="round"
21+
strokeLinejoin="round"
22+
className={className}
23+
>
24+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
25+
<path d="M17 7l-10 10" />
26+
<path d="M8 7l9 0l0 9" />
27+
</svg>
28+
);
29+
}
30+
31+
export default function EditThisPage({ editUrl }: Props): ReactNode {
32+
return (
33+
<Link
34+
to={editUrl}
35+
className={`${ThemeClassNames.common.editThisPage} ${styles.editThisPageLink}`}
36+
>
37+
<Translate
38+
id="theme.common.editThisPage"
39+
description="The link label to view the raw source for the current page"
40+
>
41+
View page as Markdown
42+
</Translate>
43+
<ExternalIcon className={styles.externalIcon} />
44+
</Link>
45+
);
46+
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.editThisPageLink,
2+
.editThisPageLink:visited {
3+
color: var(--ifm-font-color-base);
4+
text-decoration: none;
5+
transition: color var(--ifm-transition-fast)
6+
var(--ifm-transition-timing-default);
7+
}
8+
9+
.editThisPageLink:hover,
10+
.editThisPageLink:focus-visible {
11+
color: var(--ifm-color-primary);
12+
text-decoration: none;
13+
}
14+
15+
[data-theme="dark"] .editThisPageLink:hover,
16+
[data-theme="dark"] .editThisPageLink:focus-visible {
17+
color: var(--ifm-color-primary-lighter);
18+
}
19+
20+
.externalIcon {
21+
margin-left: 0.3em;
22+
vertical-align: text-bottom;
23+
stroke: currentColor;
24+
transition: color var(--ifm-transition-fast)
25+
var(--ifm-transition-timing-default);
26+
}

0 commit comments

Comments
 (0)