Git Product home page Git Product logo

Comments (1)

jlblcc avatar jlblcc commented on September 27, 2024

I created a YUIDoc theme for the editor: https://github.com/adiwg/yuidoc-mdeditor-theme. The live example is here: http://www.adiwg.org/mdEditor/docs/.

The theme is based on using modules and sub-modules to group the various components. The main app and any in-repo addons are "module" level. Sub-modules are intended to be logically grouped according to the app directory structure, e.g. "initializers" or "components-object". I figured two levels would be enough.

I added support for the "category" tag in the theme to allow doc blocks to be designated "documentation only" (set @category docs). That allows the "abstract" entities that don't represent an actual class, like sub-modules, to be documented. I started documenting the sub-modules in app.js, which seemed to make the most sense at the time.

from mdeditor.

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.