Comments (6)
Upd: After setting up underlying JSDoc and turning on partial and markdown plugins @partial worked.
Although there are issues with combining of @partial and other JSDoc tags like @param: see text after Tizen Quirks.
from cordova-discuss.
Used markdown-links in JSDoc comments to the moved big docs chunks (quirks, extra examples, etc.) to the Handlebars template file:
Result
How it works:
- Specifying a link in template
- Linking to a big doc chunk in the source code
- Result in the generated docs -> Supported platforms
from cordova-discuss.
Upd:
- Renamed hbs template to md to be viewable on Github,
- Output without JSDoc
markdown
plugin usage (no custom config is required therefore).
Summary instructions:
- Put template with license, header, intro and extra docs (detailed descriptions, supported platforms, quirks) to
jsdoc2md/README.md
(or call itTEMPLATE.md
?), - Document
www
folder source code usingJSDoc
, - Call
npm run gen-docs
to generate the documentation.
from cordova-discuss.
@axemclion @dblotsky Can you please review and comment.
from cordova-discuss.
from cordova-discuss.
@daserge We've already converted this to a proposal. Closing this now.
from cordova-discuss.
Related Issues (20)
- [cordova-create] New logic for setting attributes in package.json & config.xml (§3) HOT 2
- [cordova-create] Fix event delegation (§4) HOT 4
- [cordova-create] Do not copy "missing" files from default template (§5) HOT 1
- [cordova-create] Reduce supported template layouts (§7) HOT 1
- [cordova-create] Drop support for linking (§8) HOT 1
- [cordova-windows] dealing with template/Properties/Default.rd.xml HOT 2
- TEst HOT 1
- Migrate issues to GitHub PLEASE HOT 1
- Where to report plug-in issues? HOT 1
- Breaking changes in cordova-create HOT 9
- Do not assert Apache license on generated projects HOT 1
- Merge cordova-app-hello-world and cordova-template-reference HOT 3
- Archive deprecated repos HOT 2
- Reduce JIRA issue count HOT 3
- Introduce stale bot on GitHub
- cordova-serve release needed from master HOT 8
- Rename "osx" platform in a major release? HOT 4
- JavaScript improvements for a major release
- Cordova coho "tools release" a bit confusing HOT 6
- [cordova-create] Simplify interface of main export (§1) HOT 3
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 cordova-discuss.