Skip to content

Commit 87b2d7e

Browse files
Updated readme
1 parent 68eb7d3 commit 87b2d7e

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -449,5 +449,24 @@ ENV Variables that need to be set:
449449
2. `IBMCLOUD_APIKEY` : API key for using `ibmcloud`. This is how we upload to COS. The COS plugin needs to be installed as well. `ibmcloud plugin install cloud-object-storage`
450450

451451

452+
# Documentation
453+
454+
`/docs/docs` is a command that will generate markdown documentation. This documentation needs to be copied and updated in the https://github.ibm.com/cloud-docs/cli repo (draft branch).
455+
456+
To build the full docs locally, see https://test.cloud.ibm.com/docs-internal/writing?topic=writing-transform-local
457+
458+
```bash
459+
➜ md-source pwd
460+
/Users/chris/Code/md-source
461+
➜ md-source ls -lh
462+
total 0
463+
drwxr-xr-x 3 chris staff 96B Nov 30 12:58 build
464+
drwxr-xr-x 3 chris staff 96B Nov 30 13:01 input
465+
drwxr-xr-x 4 chris staff 128B Nov 30 13:01 output
466+
467+
➜ marked-it-cli input --output=output --footer-file=build/markdown/footer.txt --extension-file=build/markdown/headerFooterExt.js --extension-file=build/markdown/generateSectionsExt.js --extension-file=build/markdown/accessibilityExt.js --extension-file=build/markdown/jsonTocExt.js --keyref-file=build/markdown/cloudoekeyrefs.yml --overwrite --verbose --toc-json --extension-file=build/markdown/videoExt.js --extension-file=build/markdown/terraformExt.js --extension-file=build/markdown/includesExt.js --extension-file=build/markdown/glossaryExt.js --@glossary:definitions-file=/Users/chris/Code/md-source/build/markdown/glossary.json
468+
```
469+
470+
452471
## TODO
453472
Automate build with https://github.ibm.com/coligo/cli/tree/main/script

0 commit comments

Comments
 (0)