Skip to content

feat: Improve llms.txt #1796

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

feat: Improve llms.txt #1796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bf55579
feat: Improve llms.txt
HonzaTuron Aug 13, 2025
80d21ac
Merge branch 'master' into feat/better-llms
HonzaTuron Aug 13, 2025
d7e6359
feat: Add site config url
HonzaTuron Aug 13, 2025
7aa9a81
Merge remote-tracking branch 'origin/feat/better-llms' into feat/bett…
HonzaTuron Aug 13, 2025
270256e
feat: Fix markdown alternate & add absolute links
HonzaTuron Aug 13, 2025
21dde06
feat: Markdown URLs
HonzaTuron Aug 18, 2025
3c269c6
Merge remote-tracking branch 'origin/master' into feat/better-llms
HonzaTuron Aug 21, 2025
846bac7
Merge branch 'master' into feat/better-llms
HonzaTuron Aug 26, 2025
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
4 changes: 3 additions & 1 deletion apify-docs-theme/src/theme/Layout/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@ import { useLocation } from '@docusaurus/router';
// cannot use any of the theme aliases here as it causes a circular dependency :( ideas welcome
import Layout from '@docusaurus/theme-classic/lib/theme/Layout/index';
import useBaseUrl from '@docusaurus/useBaseUrl';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import { usePluginData } from '@docusaurus/useGlobalData';
import React from 'react';

export default function LayoutWrapper(props) {
const { siteConfig } = useDocusaurusContext();
const { options: { subNavbar } } = usePluginData('@apify/docs-theme');
const baseUrl = useBaseUrl('/');
const currentPath = useLocation().pathname.replace(new RegExp(`^${baseUrl}`), '');

return (
<>
<Head>
<link rel="alternate" type="text/markdown" href={`${currentPath}.md`}/>
{currentPath && <link rel="alternate" type="text/markdown" href={`${siteConfig.url}/${currentPath}.md`}/>}
</Head>
<div
style={{
Expand Down
18 changes: 15 additions & 3 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const { createApiPageMD, createInfoPageMD } = require('docusaurus-plugin-openapi

const { config } = require('./apify-docs-theme');
const { collectSlugs } = require('./tools/utils/collectSlugs');
const { externalLinkProcessor } = require('./tools/utils/externalLink');
const { externalLinkProcessor, isInternal } = require('./tools/utils/externalLink');
const { removeLlmButtons } = require('./tools/utils/removeLlmButtons');

/** @type {Partial<import('@docusaurus/types').DocusaurusConfig>} */
Expand Down Expand Up @@ -280,14 +280,26 @@ module.exports = {
}),
[
'@signalwire/docusaurus-plugin-llms-txt',
{
/** @type {import('@signalwire/docusaurus-plugin-llms-txt').PluginOptions} */
({
content: {
includeVersionedDocs: false,
enableLlmsFullTxt: true,
includeBlog: true,
includeGeneratedIndex: false,
includePages: true,
relativePaths: false,
remarkStringify: {
handlers: {
link: (node) => {
const isUrlInternal = isInternal(node.url);
const url = isUrlInternal ? `${config.absoluteUrl}${node.url}` : node.url;

if (node.title) return `[${node.title}](${url})`;
return url;
},
},
},
excludeRoutes: [
'/',
],
Expand All @@ -312,7 +324,7 @@ module.exports = {
// Add custom remark processing to remove LLM button text
remarkPlugins: [removeLlmButtons],
},
},
}),
],
// TODO this should be somehow computed from all the external sources
// [
Expand Down
6 changes: 3 additions & 3 deletions tools/utils/externalLink.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ const internalUrls = ['sdk.apify.com'];
/**
* @param {import('url').UrlWithStringQuery} href
*/
function isInternal(href) {
exports.isInternal = (href) => {
return internalUrls.some(
(internalUrl) => href.host === internalUrl
|| (!href.protocol && !href.host && (href.pathname || href.hash)),
);
}
};

/**
* @type {import('unified').Plugin}
Expand All @@ -27,7 +27,7 @@ exports.externalLinkProcessor = () => {
) {
const href = parse(node.properties.href);

if (!isInternal(href)) {
if (!exports.isInternal(href)) {
node.properties.target = '_blank';
node.properties.rel = 'noopener';
} else {
Expand Down