Comments (1)
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)
- Support Data Quality Reports Coverage Results
- Support Data Quality Reports Quality Measure
- Support Data Quality Reports Evaluation Measure
- Support Data Quality Reports Quantitative Result
- Support Data Quality Reports Descriptive Result
- Support Data Quality Reports Conformance Result
- Prepare develop branch for production release v1.2.0
- Bump version to 1.2.0 and deploy
- Fix 404 File for GitHub Pages
- Build does not increment version HOT 2
- White Dot of Death HOT 3
- Remove "beta" language
- import CSV not working for data dictionary creation HOT 2
- Fix profilePath names for extent feature
- Translate to CSDGM Failing
- Fails to republish to ScienceBase, with error "No item found for specific identifier" HOT 1
- Fix Data Quality HOT 3
- Export mdJSON function does not write dictionaryId
- Rename Stand Alone Report
- Excess data embedded into mdEditor-Json record object on import
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mdeditor.