Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
CODE PROJECT For Those Who Code
  • Home
  • Articles
  • FAQ
Community
  1. Home
  2. The Lounge
  3. Automatic documentation tools for React/typescript/javascript

Automatic documentation tools for React/typescript/javascript

Scheduled Pinned Locked Moved The Lounge
javascriptalgorithmstoolsquestion
7 Posts 4 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • realJSOPR Offline
    realJSOPR Offline
    realJSOP
    wrote on last edited by
    #1

    I am searching for a tool that will create documentation for react/typescript/javascript code. So far, Docusaurus looks like a viable candidate, but does anyone have any recommendations? (Free is good, but not a requirement.)

    ".45 ACP - because shooting twice is just silly" - JSOP, 2010
    -----
    You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
    -----
    When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

    Mircea NeacsuM Sander RosselS P 3 Replies Last reply
    0
    • realJSOPR realJSOP

      I am searching for a tool that will create documentation for react/typescript/javascript code. So far, Docusaurus looks like a viable candidate, but does anyone have any recommendations? (Free is good, but not a requirement.)

      ".45 ACP - because shooting twice is just silly" - JSOP, 2010
      -----
      You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
      -----
      When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

      Mircea NeacsuM Offline
      Mircea NeacsuM Offline
      Mircea Neacsu
      wrote on last edited by
      #2

      Hugo[^] maybe. I'm still getting the hang of it but seems quite decent.

      Mircea

      realJSOPR 1 Reply Last reply
      0
      • realJSOPR realJSOP

        I am searching for a tool that will create documentation for react/typescript/javascript code. So far, Docusaurus looks like a viable candidate, but does anyone have any recommendations? (Free is good, but not a requirement.)

        ".45 ACP - because shooting twice is just silly" - JSOP, 2010
        -----
        You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
        -----
        When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

        Sander RosselS Offline
        Sander RosselS Offline
        Sander Rossel
        wrote on last edited by
        #3

        For my arrgh.js library I've used GitHub - manuthecoder/docjs: DocJS is a pure JS documentation generator[^] and I'm pretty happy with the result. I've documented the process in my article: Arrgh.js - Bringing LINQ to JavaScript[^] You can see the results in the full documentation: arrgh.js[^] This article is from 2017, so I'm not sure how much it has changed since then.

        Best, Sander Azure DevOps Succinctly (free eBook) Azure Serverless Succinctly (free eBook) Migrating Apps to the Cloud with Azure arrgh.js - Bringing LINQ to JavaScript

        realJSOPR 1 Reply Last reply
        0
        • Sander RosselS Sander Rossel

          For my arrgh.js library I've used GitHub - manuthecoder/docjs: DocJS is a pure JS documentation generator[^] and I'm pretty happy with the result. I've documented the process in my article: Arrgh.js - Bringing LINQ to JavaScript[^] You can see the results in the full documentation: arrgh.js[^] This article is from 2017, so I'm not sure how much it has changed since then.

          Best, Sander Azure DevOps Succinctly (free eBook) Azure Serverless Succinctly (free eBook) Migrating Apps to the Cloud with Azure arrgh.js - Bringing LINQ to JavaScript

          realJSOPR Offline
          realJSOPR Offline
          realJSOP
          wrote on last edited by
          #4

          I found virtually nothing (google or youtube) about DocJS beyond the github page you cited. It's also been more than a year since the project has been updated.

          ".45 ACP - because shooting twice is just silly" - JSOP, 2010
          -----
          You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
          -----
          When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

          Sander RosselS 1 Reply Last reply
          0
          • Mircea NeacsuM Mircea Neacsu

            Hugo[^] maybe. I'm still getting the hang of it but seems quite decent.

            Mircea

            realJSOPR Offline
            realJSOPR Offline
            realJSOP
            wrote on last edited by
            #5

            I need somethin that will actually generate the mdx files for the source code. Hugo is like docusaurus where it only appears to help you generate a documentation web page. It doesn't appear to actually generate docs for source code.

            ".45 ACP - because shooting twice is just silly" - JSOP, 2010
            -----
            You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
            -----
            When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

            1 Reply Last reply
            0
            • realJSOPR realJSOP

              I found virtually nothing (google or youtube) about DocJS beyond the github page you cited. It's also been more than a year since the project has been updated.

              ".45 ACP - because shooting twice is just silly" - JSOP, 2010
              -----
              You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
              -----
              When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

              Sander RosselS Offline
              Sander RosselS Offline
              Sander Rossel
              wrote on last edited by
              #6

              When I search for "javascript documentation generator" it still keeps popping up, it's mentioned in practically all "top x best documentation tools" lists and it's still one of the most popular. Perhaps it's just a finished product that doesn't need constant updates? One website deemed it "most stable" as it's been around since 2011, which is longer than most other tools. I've found some other documentation generators that haven't been update for years (like ESDoc, which scored high on Google). Docusaurus looks good though, especially with the new v2, so I'd say go for it :thumbsup:

              Best, Sander Azure DevOps Succinctly (free eBook) Azure Serverless Succinctly (free eBook) Migrating Apps to the Cloud with Azure arrgh.js - Bringing LINQ to JavaScript

              1 Reply Last reply
              0
              • realJSOPR realJSOP

                I am searching for a tool that will create documentation for react/typescript/javascript code. So far, Docusaurus looks like a viable candidate, but does anyone have any recommendations? (Free is good, but not a requirement.)

                ".45 ACP - because shooting twice is just silly" - JSOP, 2010
                -----
                You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
                -----
                When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

                P Offline
                P Offline
                Peter Adam
                wrote on last edited by
                #7

                For C style languages, maybe Doxygen[^]. We used it eons ago for Delphi. [Documenting Doxygen with JavaScript](https://coherent-labs.com/posts/documenting-javascript-with-doxygen/) [Generate JavaScript documentation with Doxygen](https://stackoverflow.com/questions/7320464/generate-javascript-documentation-with-doxygen#9400344)

                1 Reply Last reply
                0
                Reply
                • Reply as topic
                Log in to reply
                • Oldest to Newest
                • Newest to Oldest
                • Most Votes


                • Login

                • Don't have an account? Register

                • Login or register to search.
                • First post
                  Last post
                0
                • Categories
                • Recent
                • Tags
                • Popular
                • World
                • Users
                • Groups