Link your docs directly to portions of code samples.
TODO:
-
Decouple styling from functionality as much as possible. Though custom elements would help with this because styles wouldn't leak.
- Custom element? So this dingus would be self contained and embeddable.
- At least support for easily adding multiple instances on the same page.
-
User accounts with save/share? Using gists like dabblet?
- Interactions like select code -> add note would be nice, but a pure text based higlighter should be good for a first version.
Name? Let's talk about code Code annotator CodeNotes Codeotator
Link documentation to pieces of code.
Code snippettejä, joihin liitettynä tekstiä, joka voi olla linkitettynä koodin osiin. Eroaa koodin seassa olevasta dokumentaatiosta siten että varsinkin css:ää ja html:ää dokumentoidessa pitää paljon puhua yksittäisistä atribuuteista tai valueista. Noiden kommentteja varsinkaan html:ssä ei pysty oikein dokumentoimaan sinne koodin sekaan.