Comments (5)
from scribe.
@gpbmike We will get around to this, however if youโre willing to spend 5 minutes looking at the code for the main Scribe object constructor along with our example, you should have no problems getting started. Scribe is very small in comparison to other libraries of its kind.
from scribe.
I would like to document the API using JSDoc. Tools to generate documentation from JSDoc include dgeni from the Angular team, and dox. The former is much more active but less popular.
from scribe.
Whilst I love the concept of inline docs, I've tried out a few of the generators and found them to be a bit limited after a fashion (although I'd not seen dgeni). I imagine those tools are better suited to smaller projects - but if I can forward a suggestion, I've just started using readme.io for managing the Ghost dev docs and am really loving it.
It's not inline / auto-generated but once you have it setup you can add admins and the general public can suggest edits which is much the same as a PR.
Their offering is essentially an entire developer hub centred around docs. It's versioned, has search and the option for a Q&A style discussion area. The benefit I can see is that rather that just API docs, a library of useful examples and plugin documentation could all be built up in the same place.
Just a suggestion though - that kind of thing requires time and commitment :)
Wouldn't be a bad idea to jsDoc the main scribe constructor anyway.
from scribe.
Thanks. I will have a look at readme.io and think about it. I'll designate this as low-hanging fruit, as documenting should be pretty easy to do - if mostly just time-consuming.
from scribe.
Related Issues (20)
- allowBlockElements=false in Safari prevents entering new lines HOT 2
- Pressing Enter while having a selection in inline-mode does not delete the range content HOT 1
- Roadmap to making Safari support official?
- lodash dependecy still exists. HOT 10
- Pasting inserts paragraph tags even in inline-mode
- Remove Unexpected Usage of ES6 const HOT 2
- NPM releases improvements HOT 3
- Pull requests welcome? HOT 1
- Scribe commands not working when triggered in child iframe HOT 1
- whether consider supporting umd๏ผ HOT 2
- command plugin problem
- Edge compatibility HOT 1
- cjs version [email protected] does not work with browserify w/ deamdify
- UndoManager and a max length plugin
- Any chance of supporting lists?
- Un able to import Scribe using angular Cli
- plugin injection into existing `scribe` instance HOT 1
- Demo is broken
- Selection.range collapses when selecting the last word of a paragraph HOT 5
- Text alignment
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 scribe.