a11y.css
a11y.css copied to clipboard
Documentation: references feeds, multi-language?
If that's doable, we should do it. I'd love to give the full documentation in French.
Asked to Trulia in https://github.com/trulia/hologram/issues/256
By extending SassDoc with our own annotations, you could build pretty much whatever you want.
I'm indeed considering this since I made a tour in SassDoc theming, I think it would be pretty easy to replace the Hologram part with SassDoc.
Though multi-language would be another level. It'll probably need to duplicate SassDoc comments for each language, am I right?
Basically yes. You’ll create specific annotation like @desc:fr
, and @desc:en
, then display them the way you want in your theme. I can help you with that if you want.
I think that's what I'll do. This seems really easier.
Simple note to consider using Infusion (but it would require to write doc outside of sass files).
Note: Infusion became Cupper.
As an idea, multi-language documentation could lead to more specific references links: RGAA for french version, Section 508 for english (just an example 😋), etc.
This issue is becoming a whole project, I'll move it.
Note: the Hermann SassDoc theme evolved quite a lot: probably a great source of inspiration to push a11y.css' SassDoc further :)
Also see CSSDoc which seems to be very similar to Hologram, in its documentation syntax.