Skip to content

Commit 54c098c

Browse files
crandmckcrandmck
committed
Add new md files to fetch-readmes and sidebars
1 parent 2691a01 commit 54c098c

File tree

3 files changed

+186
-31
lines changed

3 files changed

+186
-31
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
.cache-loader
1010
/docs/js-sdk/api
1111
/docs/c2patool
12+
/docs/c2pa-node
13+
/docs/c2pa-python
14+
/docs/c2pa-c
1215
/docs/rust-sdk
1316
/docs/**/readme.md
1417

‎scripts/fetch-readme.js‎

Lines changed: 102 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,66 +19,150 @@ $ touch .gitkeep
1919
*/
2020

2121
const readmes = [
22+
// c2patool
2223
{
23-
dest: resolve(__dirname, '../docs/rust-sdk/readme.md'),
24-
repo: 'contentauth/c2pa-rs',
24+
dest: resolve(__dirname, '../docs/c2patool/readme.md'),
25+
repo: 'contentauth/c2patool',
2526
path: 'README.md',
27+
branch: 'crandmck/update-contributing',
2628
},
2729
{
28-
dest: resolve(__dirname, '../docs/c2pa-min/readme.md'),
29-
repo: 'contentauth/c2pa-min',
30-
path: 'README.md',
30+
dest: resolve(__dirname, '../docs/c2patool/docs/usage.md'),
31+
repo: 'contentauth/c2patool',
32+
path: 'docs/usage.md',
33+
branch: 'crandmck/update-contributing',
3134
},
3235
{
33-
dest: resolve(__dirname, '../docs/c2patool/readme.md'),
34-
repo: 'contentauth/c2patool',
35-
path: 'README.md',
36+
dest: resolve(__dirname, '../docs/c2patool/docs/supported-formats.md'),
37+
repo: 'contentauth/c2pa-rs',
38+
path: 'docs/supported-formats.md',
39+
branch: 'crandmck/reorg-docs',
3640
},
3741
{
38-
dest: resolve(__dirname, '../docs/c2patool/manifest.md'),
42+
dest: resolve(__dirname, '../docs/c2patool/docs/manifest.md'),
3943
repo: 'contentauth/c2patool',
4044
path: 'docs/manifest.md',
45+
branch: 'crandmck/update-contributing',
4146
},
4247
{
43-
dest: resolve(__dirname, '../docs/c2patool/x_509.md'),
48+
dest: resolve(__dirname, '../docs/c2patool/docs/x_509.md'),
4449
repo: 'contentauth/c2patool',
4550
path: 'docs/x_509.md',
51+
branch: 'crandmck/update-contributing',
4652
},
4753
{
48-
dest: resolve(__dirname, '../docs/c2patool/release-notes.md'),
54+
dest: resolve(__dirname, '../docs/c2patool/docs/release-notes.md'),
4955
repo: 'contentauth/c2patool',
5056
path: 'docs/release-notes.md',
57+
branch: 'crandmck/update-contributing',
5158
},
5259
{
5360
dest: resolve(__dirname, '../docs/c2pa-service-example/readme.md'),
5461
repo: 'contentauth/c2pa-service-example',
5562
path: 'README.md',
5663
},
64+
// Node.js lib
5765
{
58-
dest: resolve(__dirname, '../docs/c2pa-c/readme.md'),
59-
repo: 'contentauth/c2pa-c',
66+
dest: resolve(__dirname, '../docs/c2pa-node/readme.md'),
67+
repo: 'contentauth/c2pa-node',
6068
path: 'README.md',
69+
branch: 'crandmck/docs-overhaul',
6170
},
6271
{
63-
dest: resolve(__dirname, '../docs/c2pa-node/readme.md'),
72+
dest: resolve(__dirname, '../docs/c2pa-node/docs/usage.md'),
6473
repo: 'contentauth/c2pa-node',
65-
path: 'README.md',
74+
path: 'docs/usage.md',
75+
branch: 'crandmck/docs-overhaul',
76+
},
77+
{
78+
dest: resolve(__dirname, '../docs/c2pa-node/docs/supported-formats.md'),
79+
repo: 'contentauth/c2pa-rs',
80+
path: 'docs/supported-formats.md',
81+
branch: 'crandmck/reorg-docs',
82+
},
83+
{
84+
dest: resolve(__dirname, '../docs/c2pa-node/docs/release-notes.md'),
85+
repo: 'contentauth/c2pa-node',
86+
path: 'docs/release-notes.md',
87+
branch: 'crandmck/docs-overhaul',
6688
},
6789
{
6890
dest: resolve(__dirname, '../docs/c2pa-node-example/readme.md'),
6991
repo: 'contentauth/c2pa-node-example',
7092
path: 'README.md',
7193
},
94+
// Python lib
7295
{
7396
dest: resolve(__dirname, '../docs/c2pa-python/readme.md'),
7497
repo: 'contentauth/c2pa-python',
7598
path: 'README.md',
99+
branch: 'docs/add-rns-and-reorg',
100+
},
101+
{
102+
dest: resolve(__dirname, '../docs/c2pa-python/docs/usage.md'),
103+
repo: 'contentauth/c2pa-python',
104+
path: 'docs/usage.md',
105+
branch: 'docs/add-rns-and-reorg',
106+
},
107+
{
108+
dest: resolve(__dirname, '../docs/c2pa-python/docs/supported-formats.md'),
109+
repo: 'contentauth/c2pa-rs',
110+
path: 'docs/supported-formats.md',
111+
branch: 'crandmck/reorg-docs',
112+
},
113+
{
114+
dest: resolve(__dirname, '../docs/c2pa-python/docs/release-notes.md'),
115+
repo: 'contentauth/c2pa-python',
116+
path: 'docs/release-notes.md',
117+
branch: 'docs/add-rns-and-reorg',
76118
},
77119
{
78120
dest: resolve(__dirname, '../docs/c2pa-python-example/readme.md'),
79121
repo: 'contentauth/c2pa-python-example',
80122
path: 'README.md',
81123
},
124+
// C lib
125+
{
126+
dest: resolve(__dirname, '../docs/c2pa-c/readme.md'),
127+
repo: 'contentauth/c2pa-c',
128+
path: 'README.md',
129+
},
130+
{
131+
dest: resolve(__dirname, '../docs/c2pa-c/docs/supported-formats.md'),
132+
repo: 'contentauth/c2pa-rs',
133+
path: 'docs/supported-formats.md',
134+
branch: 'crandmck/reorg-docs',
135+
},
136+
// Rust lib
137+
{
138+
dest: resolve(__dirname, '../docs/rust-sdk/readme.md'),
139+
repo: 'contentauth/c2pa-rs',
140+
path: 'README.md',
141+
branch: 'crandmck/reorg-docs',
142+
},
143+
{
144+
dest: resolve(__dirname, '../docs/rust-sdk/docs/supported-formats.md'),
145+
repo: 'contentauth/c2pa-rs',
146+
path: 'docs/supported-formats.md',
147+
branch: 'crandmck/reorg-docs',
148+
},
149+
{
150+
dest: resolve(__dirname, '../docs/rust-sdk/docs/usage.md'),
151+
repo: 'contentauth/c2pa-rs',
152+
path: 'docs/usage.md',
153+
branch: 'crandmck/reorg-docs',
154+
},
155+
{
156+
dest: resolve(__dirname, '../docs/rust-sdk/docs/release-notes.md'),
157+
repo: 'contentauth/c2pa-rs',
158+
path: 'docs/release-notes.md',
159+
branch: 'crandmck/reorg-docs',
160+
},
161+
{
162+
dest: resolve(__dirname, '../docs/c2pa-min/readme.md'),
163+
repo: 'contentauth/c2pa-min',
164+
path: 'README.md',
165+
},
82166
];
83167

84168
function resolveMarkdownLinks(linkBase, content) {
@@ -101,8 +185,9 @@ async function download() {
101185
const linkBase = `${GITHUB_HOST}/${repo}/blob/${branch}/${path}`;
102186
const res = await fetch(src);
103187
const markdown = await res.text();
104-
const resolvedMarkdown = resolveMarkdownLinks(linkBase, markdown);
105-
await writeFile(dest, resolvedMarkdown, { encoding: 'utf-8', flag: 'w+' });
188+
//const resolvedMarkdown = resolveMarkdownLinks(linkBase, markdown);
189+
//await writeFile(dest, resolvedMarkdown, { encoding: 'utf-8', flag: 'w+' });
190+
await writeFile(dest, markdown, { encoding: 'utf-8', flag: 'w+' });
106191
console.log('Saved %s to %s', src, dest);
107192
}
108193
}

‎sidebars.js‎

Lines changed: 81 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,33 @@ const sidebars = {
6969
items: [
7070
{
7171
type: 'doc',
72-
id: 'c2patool/manifest',
72+
id: 'c2patool/docs/usage',
73+
label: 'Using C2PA Tool',
74+
},
75+
{
76+
type: 'doc',
77+
id: 'c2patool/docs/supported-formats',
78+
label: 'Supported media formats',
79+
},
80+
{
81+
type: 'doc',
82+
id: 'c2patool/docs/manifest',
7383
label: 'Using a manifest file',
7484
},
7585
{
7686
type: 'doc',
77-
id: 'c2patool/x_509',
87+
id: 'c2patool/docs/x_509',
7888
label: 'Creating and using a certificate',
7989
},
90+
{
91+
type: 'doc',
92+
id: 'c2patool/docs/release-notes',
93+
label: 'Release notes',
94+
},
8095
{
8196
type: 'doc',
8297
id: 'c2pa-service-example/readme',
98+
label: 'C2PA Tool service example',
8399
},
84100
{
85101
type: 'link',
@@ -109,14 +125,30 @@ const sidebars = {
109125
collapsed: true,
110126
items: [
111127
{
112-
type: 'link',
113-
label: 'GitHub',
114-
href: 'https://github.com/contentauth/c2pa-node',
128+
type: 'doc',
129+
id: 'c2pa-node/docs/usage',
130+
label: 'Using the Node library',
131+
},
132+
{
133+
type: 'doc',
134+
id: 'c2pa-node/docs/supported-formats',
135+
label: 'Supported media formats',
115136
},
116137
{
117138
type: 'doc',
139+
id: 'c2pa-node/docs/release-notes',
140+
label: 'Release notes',
141+
},
142+
{
143+
type: 'doc',
144+
label: 'C2PA Node example',
118145
id: 'c2pa-node-example/readme',
119146
},
147+
{
148+
type: 'link',
149+
label: 'GitHub',
150+
href: 'https://github.com/contentauth/c2pa-node',
151+
},
120152
],
121153
},
122154
{
@@ -126,14 +158,29 @@ const sidebars = {
126158
collapsed: true,
127159
items: [
128160
{
129-
type: 'link',
130-
label: 'GitHub',
131-
href: 'https://github.com/contentauth/c2pa-python',
161+
type: 'doc',
162+
id: 'c2pa-python/docs/usage',
163+
label: 'Using the Python library',
164+
},
165+
{
166+
type: 'doc',
167+
id: 'c2pa-python/docs/supported-formats',
168+
label: 'Supported media formats',
169+
},
170+
{
171+
type: 'doc',
172+
id: 'c2pa-python/docs/release-notes',
173+
label: 'Release notes',
132174
},
133175
{
134176
type: 'doc',
135-
label: 'C2PA Python Example',
136177
id: 'c2pa-python-example/readme',
178+
label: 'C2PA Python example',
179+
},
180+
{
181+
type: 'link',
182+
label: 'GitHub',
183+
href: 'https://github.com/contentauth/c2pa-python',
137184
},
138185
],
139186
},
@@ -143,6 +190,11 @@ const sidebars = {
143190
link: { type: 'doc', id: 'c2pa-c/readme' },
144191
collapsed: true,
145192
items: [
193+
{
194+
type: 'doc',
195+
id: 'c2pa-c/docs/supported-formats',
196+
label: 'Supported media formats',
197+
},
146198
{
147199
type: 'link',
148200
label: 'GitHub',
@@ -159,21 +211,36 @@ const sidebars = {
159211
link: { type: 'doc', id: 'rust-sdk/readme' },
160212
collapsed: true,
161213
items: [
214+
{
215+
type: 'doc',
216+
id: 'rust-sdk/docs/usage',
217+
label: 'Using the Rust library',
218+
},
219+
{
220+
type: 'doc',
221+
id: 'rust-sdk/docs/supported-formats',
222+
label: 'Supported media formats',
223+
},
224+
{
225+
type: 'doc',
226+
id: 'rust-sdk/docs/release-notes',
227+
label: 'Release notes',
228+
},
162229
{
163230
type: 'link',
164231
label: 'API documentation',
165232
href: 'https://docs.rs/c2pa',
166233
},
234+
{
235+
type: 'doc',
236+
id: 'c2pa-min/readme',
237+
label: 'C2PA Rust example application',
238+
},
167239
{
168240
type: 'link',
169241
label: 'GitHub',
170242
href: 'https://github.com/contentauth/c2pa-rs',
171243
},
172-
{
173-
type: 'doc',
174-
label: 'C2PA Rust example application',
175-
id: 'c2pa-min/readme',
176-
},
177244
],
178245
},
179246
{

0 commit comments

Comments
 (0)