Uploaded image for project: 'Compass '
  1. Compass
  2. COMPASS-4147

Automated jsdocs in README's

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Won't Do
    • Icon: Major - P3 Major - P3
    • None
    • None
    • Tech debt
    • None

    Description

      • We have a lot of context on implementation buried in our JS docs (e.g. import export) that would be valuable to productivity if discoverable. Scripts to include structured jsdoc in README.md's is the most direct for our workflows.

      via maurizio.casimirri

      ```
      npm i --save-dev markdown-toc jsdoc2md node-injectmd
      ```
      #### package.json scripts
      ```
      "docs": "npm run docs:jsdoc && npm run docs:toc",
      "docs:toc": "markdown-toc -i README.md",
      "docs:jsdoc": "jsdoc2md -d 3 -c .jsdocrc lib/**/*.js | node-injectmd -t docs -i README.md",
      ```
      #### README.md
      ``` md
      <!-- toc -->
      <!-- tocstop -->
      # Api
      ```
      

      Attachments

        Activity

          People

            Unassigned Unassigned
            lucas.hrabovsky Lucas Hrabovsky (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: