a11y.css icon indicating copy to clipboard operation
a11y.css copied to clipboard

Documentation: references feeds, multi-language?

Open ffoodd opened this issue 9 years ago • 9 comments

If that's doable, we should do it. I'd love to give the full documentation in French.

ffoodd avatar Jan 15 '15 13:01 ffoodd

Asked to Trulia in https://github.com/trulia/hologram/issues/256

ffoodd avatar Dec 17 '15 11:12 ffoodd

By extending SassDoc with our own annotations, you could build pretty much whatever you want.

KittyGiraudel avatar Apr 21 '16 13:04 KittyGiraudel

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?

ffoodd avatar Apr 21 '16 13:04 ffoodd

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.

KittyGiraudel avatar Apr 21 '16 13:04 KittyGiraudel

I think that's what I'll do. This seems really easier.

ffoodd avatar Apr 21 '16 13:04 ffoodd

Simple note to consider using Infusion (but it would require to write doc outside of sass files).

Note: Infusion became Cupper.

ffoodd avatar Oct 09 '17 12:10 ffoodd

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.

ffoodd avatar Nov 23 '17 09:11 ffoodd

Note: the Hermann SassDoc theme evolved quite a lot: probably a great source of inspiration to push a11y.css' SassDoc further :)

ffoodd avatar Jan 05 '18 08:01 ffoodd

Also see CSSDoc which seems to be very similar to Hologram, in its documentation syntax.

ffoodd avatar Nov 12 '19 15:11 ffoodd