Skip to content

Commit 07474df

Browse files
committed
chore: only push readme to remote
1 parent 22c4c1c commit 07474df

File tree

4 files changed

+16
-38
lines changed

4 files changed

+16
-38
lines changed

.github/sync.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
magicbell/magicbell:
22
- source: docs-dist
3-
dest: src/go/app/site/docs/mdx/03-libraries/magicbell-java-user-client
3+
dest: src/go/app/site/docs/mdx/03-libraries/magicbell-java-user-client
4+
deleteOrphaned: true

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"@types/node": "^22.10.2",
1616
"glob": "^11.0.0",
1717
"replace-in-file": "^8.2.0",
18-
"tsx": "^4.19.2"
18+
"tsx": "^4.19.2",
19+
"url-join": "^5.0.0"
1920
}
2021
}

scripts/liblab-docs.ts

+7-36
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
11
import fs from 'node:fs/promises';
22
import path from 'node:path';
33

4-
import { exists, getDirs } from '@magicbell/codegen/fs';
54
import * as md from '@magicbell/codegen/markdown';
65
import * as glob from 'glob';
7-
8-
function pascalToHyphenCase(str: string): string {
9-
return str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
10-
}
11-
12-
function rewriteHref(url: string) {
13-
if (!url.endsWith('.md')) return url;
14-
return url.replace(/^documentation\//, '').replace(/([^/]+)\.md$/, (_, fileName) => pascalToHyphenCase(fileName));
15-
}
6+
import urlJoin from 'url-join';
167

178
const root = process.cwd();
189
const outdir = path.join(root, 'docs-dist');
1910
await fs.rm(outdir, { recursive: true, force: true });
2011

2112
const pkg = JSON.parse(await fs.readFile('package.json', 'utf-8'));
13+
const repoUrl = 'https://github.com/magicbell/magicbell-java-user-client/blob/main'
14+
15+
function rewriteHref(url: string) {
16+
if (url.startsWith('http://') || url.startsWith('https://')) return url;
17+
return urlJoin(repoUrl, url);
18+
}
2219

2320
// process readme
2421
const [readme] = glob.sync('README.md', { cwd: root });
@@ -29,29 +26,3 @@ md.mapLinks(readmeAst, rewriteHref);
2926
md.insertFrontMatter(readmeAst, { title: pkg.name });
3027

3128
await md.write(readmeAst, path.join(outdir, 'index.mdx'));
32-
33-
// process pages
34-
const docs = glob.sync('**/*.md', {
35-
cwd: path.join(root, 'documentation'),
36-
});
37-
38-
for (const file of docs) {
39-
const ast = await md.read(path.join(root, 'documentation', file));
40-
41-
md.reIndentHeadings(ast, 1);
42-
md.mapLinks(ast, rewriteHref);
43-
44-
const title = md.getTitle(ast);
45-
md.insertFrontMatter(ast, { title });
46-
md.removeFirstHeading(ast);
47-
48-
await md.write(ast, path.join(outdir, pascalToHyphenCase(file) + 'x'));
49-
}
50-
51-
for (const dir of getDirs(docs)) {
52-
const file = path.join(outdir, dir, 'index.mdx');
53-
if (await exists(file)) continue;
54-
const ast: md.Root = { type: 'root', children: [] };
55-
md.insertFrontMatter(ast, { title: path.basename(dir) });
56-
await md.write(ast, file);
57-
}

yarn.lock

+5
Original file line numberDiff line numberDiff line change
@@ -2326,6 +2326,11 @@ uri-js@^4.2.2:
23262326
dependencies:
23272327
punycode "^2.1.0"
23282328

2329+
url-join@^5.0.0:
2330+
version "5.0.0"
2331+
resolved "https://registry.yarnpkg.com/url-join/-/url-join-5.0.0.tgz#c2f1e5cbd95fa91082a93b58a1f42fecb4bdbcf1"
2332+
integrity sha512-n2huDr9h9yzd6exQVnH/jU5mr+Pfx08LRXXZhkLLetAMESRj+anQsTAh940iMrIetKAmry9coFuZQ2jY8/p3WA==
2333+
23292334
validate.io-array@^1.0.3:
23302335
version "1.0.6"
23312336
resolved "https://registry.yarnpkg.com/validate.io-array/-/validate.io-array-1.0.6.tgz#5b5a2cafd8f8b85abb2f886ba153f2d93a27774d"

0 commit comments

Comments
 (0)