Skip to content

Avoid re-rendering readmes #461

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

Closed
BenjaminSchaaf wants to merge 1 commit into from
+11 −2
Closed

Avoid re-rendering readmes #461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion eleventy.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ export default async function (eleventyConfig) {
installed: stat?.installs?.totals ?? 0,
installs_window: stat?.installs?.yearly?.reduce((a, b) => a + b, 0) ?? 0,
...(readme_url !== pkg.readme ? { readme_url } : {}),
...(renderedReadmes[pkg.readme] ? { rendered_readme: renderedReadmes[pkg.readme] } : {}),
...(renderedReadmes[pkg.readme] ? { rendered_readme: renderedReadmes[pkg.readme][1] } : {}),
...(source_url !== pkg.source ? { source_url } : {}),
}
}
Expand Down
11 changes: 10 additions & 1 deletion render_readmes.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,31 @@ import { JSDOM } from 'jsdom'
import createDOMPurify from 'dompurify'
import { marked } from 'marked'
import { configureMarked, renderReadme } from './static/readme-renderer.mjs'
import { createHash } from 'crypto'

const args = parseArgs(process.argv.slice(2))
const rawReadmes = readJson(args.input)
const dom = new JSDOM('')
const DOMPurify = createDOMPurify(dom.window)
const parser = new dom.window.DOMParser()

const oldRenderedReadmes = readJson(args.output)
const renderedReadmes = {}

configureMarked(marked)

for (const [url, text] of Object.entries(rawReadmes)) {
const hash = createHash('sha256').update(text).digest('base64')
if (oldRenderedReadmes[url] && oldRenderedReadmes[url][0] === hash) {
renderedReadmes[url] = [hash, oldRenderedReadmes[url][1]]
continue
}

const html = renderReadme(marked, text, url, {
sanitize: html => DOMPurify.sanitize(html),
parseHtml: html => parser.parseFromString(html, 'text/html'),
})
renderedReadmes[url] = html
renderedReadmes[url] = [hash, html]
}

fs.writeFileSync(args.output, JSON.stringify(renderedReadmes, null, 2) + '\n')
Expand Down