Home

These are notes on developing docs and using the site.

Adding an external md file to docs

The site includes markdown files from a number of other repos in the contentauth org.

Add the file to the fetch-readme script

To add a markdown file from a new external repo to the doc site:

Edit scripts/fetch-readme.js and add something like

{
    dest: resolve(__dirname, '../docs/<repo_name>/readme.md'),
    repo: 'contentauth/<repo_name>',
    path: 'README.md',  
},

IMPORTANT: If this is the first time you used a file from this repo, manually create new <repo_name> sub-directory of /docs per above. If you don't do this, the local build will fail.

If you need to get the README from a branch other than main, add a branch property like this:

{
  dest: resolve(__dirname, '../docs/c2pa-python-example/readme.md'),
  repo: 'contentauth/c2pa-python',
  path: 'README.md',
  branch: 'name-of-your-branch'
},

Run the script:

npm run docs:fetch-readme

Then run npm start as usual to run site locally.

Add the file to the sidebar nav

Edit sidebars.js and add something like:

{
   type: 'doc',
   id: '<repo_name>/readme',
},