patternfly-java/showcase/markdown.mjs at main · patternfly-java/patternfly-java · GitHub

History

296 lines (254 loc) · 9.03 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

* https://www.apache.org/licenses/LICENSE-2.0

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

import {existsSync, mkdirSync, readdirSync, readFileSync, statSync, writeFileSync} from 'fs';

import {basename, join, relative, resolve} from 'path';

import {unified} from 'unified';

import remarkParse from 'remark-parse';

import remarkGfm from 'remark-gfm';

import remarkFrontmatter from 'remark-frontmatter';

import remarkRehype from 'remark-rehype';

import rehypeSlug from 'rehype-slug';

import rehypeShiki from '@shikijs/rehype';

import rehypeStringify from 'rehype-stringify';

import YAML from 'yaml';

const MARKDOWN_DIR = resolve(import.meta.dirname, 'markdown');

const OUTPUT_DIR = resolve(import.meta.dirname, 'src/web/public/markdown');

const PF_HEADING_CLASSES = {

h1: 'pf-v6-c-title pf-m-4xl',

h2: 'pf-v6-c-title pf-m-2xl',

h3: 'pf-v6-c-title pf-m-lg',

};

// ------------------------------------------------------ remark/rehype plugins

function extractFrontmatter() {

return (tree, file) => {

const yamlNode = tree.children.find(node => node.type === 'yaml');

if (yamlNode) {

file.data.frontmatter = YAML.parse(yamlNode.value);

tree.children = tree.children.filter(node => node.type !== 'yaml');

}

};

}

function extractToc() {

return (tree, file) => {

const toc = [];

for (const node of tree.children) {

if (node.type === 'heading' && node.depth >= 2 && node.depth <= 3) {

const text = node.children

.filter(child => child.type === 'text')

.map(child => child.value)

.join('');

if (text) {

toc.push({text, level: node.depth});

}

file.data.toc = toc;

};

}

function addHeadingClasses() {

return (tree) => {

function visit(node) {

if (node.type === 'element' && PF_HEADING_CLASSES[node.tagName]) {

const classes = PF_HEADING_CLASSES[node.tagName];

node.properties = node.properties || {};

const existing = node.properties.className || [];

node.properties.className = [...existing, ...classes.split(' ')];

}

if (node.children) {

node.children.forEach(visit);

}

visit(tree);

};

}

// ------------------------------------------------------ processor

async function createProcessor() {

return unified()

.use(remarkParse)

.use(remarkGfm)

.use(remarkFrontmatter, ['yaml'])

.use(extractFrontmatter)

.use(extractToc)

.use(remarkRehype, {allowDangerousHtml: true})

.use(rehypeSlug)

.use(addHeadingClasses)

.use(rehypeShiki, {

themes: {

light: 'github-light',

dark: 'github-dark',

defaultColor: 'light',

langs: ['java', 'xml', 'javascript', 'json', 'html', 'css', 'bash'],

})

.use(rehypeStringify, {allowDangerousHtml: true});

}

async function processFile(processor, filePath) {

const markdown = readFileSync(filePath, 'utf-8');

const result = await processor.process(markdown);

const frontmatter = result.data.frontmatter || {};

const toc = result.data.toc || [];

if (!frontmatter.id) {

const name = basename(filePath, '.md');

console.warn(`Warning: ${filePath} has no 'id' in frontmatter, using filename '${name}'`);

frontmatter.id = name;

}

const tocWithIds = toc.map(entry => ({

id: entry.text.toLowerCase().replace(/[^\w]+/g, '-').replace(/(^-|-$)/g, ''),

text: entry.text,

level: entry.level,

}));

return {

id: frontmatter.id,

title: frontmatter.title || frontmatter.id,

order: frontmatter.order ?? 0,

html: String(result),

toc: tocWithIds,

};

}

// ------------------------------------------------------ directory walker

function titleCase(str) {

return str.replace(/(^|-)(\w)/g, (_, _sep, c) => ((_ === '') ? c : ' ' + c).toUpperCase());

}

function readMeta(dirPath) {

const metaPath = join(dirPath, 'index.yaml');

if (existsSync(metaPath)) {

return YAML.parse(readFileSync(metaPath, 'utf-8')) || {};

}

return null;

}

async function walkDirectory(processor, dirPath, parentRoute) {

const entries = readdirSync(dirPath).sort();

const items = [];

let count = 0;

const mdFiles = entries.filter(e => e.endsWith('.md') && !(parentRoute === '' && e === 'home.md'));

const subdirs = entries.filter(e => {

const full = join(dirPath, e);

return statSync(full).isDirectory();

});

// process markdown files in this directory

for (const file of mdFiles) {

const filePath = join(dirPath, file);

const data = await processFile(processor, filePath);

const route = parentRoute === '/'

? `/${data.id}`

: `${parentRoute}/${data.id}`;

const relId = relative(MARKDOWN_DIR, filePath).replace(/\.md$/, '');

// write JSON

const outputPath = resolve(OUTPUT_DIR, `${relId}.json`);

mkdirSync(resolve(outputPath, '..'), {recursive: true});

writeFileSync(outputPath, JSON.stringify({

id: relId,

title: data.title,

html: data.html,

toc: data.toc,

}, null, 2), 'utf-8');

console.log(` ${relative(MARKDOWN_DIR, filePath)} → markdown/${relId}.json`);

count++;

items.push({

type: 'page',

id: relId,

route,

title: data.title,

order: data.order,

});

}

// process subdirectories

for (const dir of subdirs) {

const dirFullPath = join(dirPath, dir);

const dirRoute = parentRoute === '/'

? `/${dir}`

: `${parentRoute}/${dir}`;

const meta = readMeta(dirFullPath);

let groupTitle = titleCase(dir);

let groupOrder = 0;

if (meta) {

groupTitle = meta.title || groupTitle;

groupOrder = meta.order ?? 0;

}

const result = await walkDirectory(processor, dirFullPath, dirRoute);

count += result.count;

const group = {

type: 'group',

id: dir,

route: dirRoute,

title: groupTitle,

order: groupOrder,

};

if (result.items.length > 0) {

group.children = result.items;

}

items.push(group);

}

// sort by order, then by title

items.sort((a, b) => {

if (a.order !== b.order) return a.order - b.order;

return a.title.localeCompare(b.title);

});

return {items, count};

}

// ------------------------------------------------------ special: home.md

async function processHome(processor) {

const homePath = join(MARKDOWN_DIR, 'home.md');

if (!existsSync(homePath)) {

return null;

}

const data = await processFile(processor, homePath);

const outputPath = resolve(OUTPUT_DIR, 'home.json');

writeFileSync(outputPath, JSON.stringify({

id: 'home',

title: data.title,

html: data.html,

toc: data.toc,

}, null, 2), 'utf-8');

console.log(` home.md → markdown/home.json`);

return {

type: 'page',

id: 'home',

route: '/',

title: data.title,

order: 0,

};

}

// ------------------------------------------------------ main

async function main() {

if (!existsSync(MARKDOWN_DIR)) {

console.error(`Markdown directory not found: ${MARKDOWN_DIR}`);

process.exit(1);

}

mkdirSync(OUTPUT_DIR, {recursive: true});

const processor = await createProcessor();

// process home.md separately (maps to /)

const homeItem = await processHome(processor);

let totalCount = homeItem ? 1 : 0;

// walk the rest of the directory tree (excluding home.md and index.md at root)

const result = await walkDirectory(processor, MARKDOWN_DIR, '');

totalCount += result.count;

// build manifest: home first, then everything else

const manifest = [];

if (homeItem) {

manifest.push(homeItem);

}

manifest.push(...result.items);

// write manifest

const manifestPath = resolve(OUTPUT_DIR, 'manifest.json');

writeFileSync(manifestPath, JSON.stringify(manifest, null, 2), 'utf-8');

console.log(` manifest.json`);

console.log(`Processed ${totalCount} markdown files`);

}

main().catch(err => {

console.error('Error processing markdown:', err);

process.exit(1);

});

patternfly-java/showcase/markdown.mjs at main · patternfly-java/patternfly-java · GitHub

Uh oh!

Expand file tree

Breadcrumbs

markdown.mjs

Latest commit

History

Breadcrumbs

markdown.mjs

File metadata and controls