Skip to content

Add markdown output in preparation for llms.txt #1632

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
merged 3 commits into from
Jun 4, 2025
Merged

Add markdown output in preparation for llms.txt #1632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d674a46
Add markdown output in preparation for llms.txt
paoloredis May 29, 2025
9f1cdb2
Update basename used for markdown files to match format required by l…
paoloredis May 30, 2025
5f8e211
Fix images links and remove all other shortcode usage
paoloredis Jun 3, 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
11 changes: 10 additions & 1 deletion config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,15 @@ rdi_current_version = "1.8.0"

# Everything below this are Site Params

# Add markdown output
[outputFormats]
[outputFormats.markdown]
name = "markdown"
baseName = "index.html"
mediaType = "text/markdown"
isPlainText = true

# Comment out if you don't want the "print entire section" link enabled.
[outputs]
section = ["HTML", "RSS"] # print
section = ["HTML", "RSS", "Markdown"] # print
page = ["HTML", "Markdown"]
14 changes: 14 additions & 0 deletions layouts/_default/section.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# {{ .Title }}
{{ $content := .RawContent }}

{{/* Fix relrefs */}}
{{ $content := $content | replaceRE "\\{\\{< ?relref \"([^\"]+)\" ?>\\}\\}" "https://redis.io/docs/latest$1" }}

{{/* Fix images */}}
{{ $content := $content | replaceRE "\\{\\{< ?image filename=\"([^\"]+)\" ?>\\}\\}" "![$1](https://redis.io/docs/latest$1)" }}

{{/* Remove all shortcodes */}}
{{ $content := $content | replaceRE "\\{\\{% ?/?.*%\\}\\}" "" }}
{{ $content := $content | replaceRE "\\{\\{< ?/?.*>\\}\\}" "" }}

{{ $content }}
14 changes: 14 additions & 0 deletions layouts/_default/single.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# {{ .Title }}
{{ $content := .RawContent }}

{{/* Fix relrefs */}}
{{ $content := $content | replaceRE "\\{\\{< ?relref \"([^\"]+)\" ?>\\}\\}" "https://redis.io/docs/latest$1" }}

{{/* Fix images */}}
{{ $content := $content | replaceRE "\\{\\{< ?image filename=\"([^\"]+)\" ?>\\}\\}" "![$1](https://redis.io/docs/latest$1)" }}

{{/* Remove all shortcodes */}}
{{ $content := $content | replaceRE "\\{\\{% ?/?.*%\\}\\}" "" }}
{{ $content := $content | replaceRE "\\{\\{< ?/?.*>\\}\\}" "" }}

{{ $content }}