GithubHelp home page GithubHelp logo

Comments (4)

fodor0205 avatar fodor0205 commented on September 3, 2024

Maybe:
https://github.com/jashkenas/docco

from tali.

Wizek avatar Wizek commented on September 3, 2024

Possibilities:

  • Automated generators from text
    • Docco
      • adventages
        • Freeform, no restrictions what so ever
        • Markdown parsed in comments
        • Syntax highlighting for code
      • disadventages
        • No predefined framework, one has to invent their onw
      • known issues
    • Dox
      • adventages
      • disadventages
      • known issues
        • Crashes if there is even a single folder around the main script dir
    • Doc.md
      • adventages
      • disadventages
      • known issues
        • Restrictive, only counts global variables and exported functions
  • Other
    • e.g. writing in github wiki
    • What else?

from tali.

Wizek avatar Wizek commented on September 3, 2024

Docco makes nice-looking doc: (link)
Docco-generated

from tali.

Wizek avatar Wizek commented on September 3, 2024

For some time, this is settled for Docco-

from tali.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.