Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: references feeds, multi-language? #134

Open
ffoodd opened this issue Jan 15, 2015 · 9 comments
Open

Documentation: references feeds, multi-language? #134

ffoodd opened this issue Jan 15, 2015 · 9 comments

Comments

@ffoodd
Copy link
Owner

ffoodd commented Jan 15, 2015

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

@ffoodd
Copy link
Owner Author

ffoodd commented Dec 17, 2015

Asked to Trulia in trulia/hologram#256

@ffoodd ffoodd modified the milestones: 4.0, 3.0 Mar 17, 2016
@KittyGiraudel
Copy link
Collaborator

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

@ffoodd
Copy link
Owner Author

ffoodd commented Apr 21, 2016

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?

@KittyGiraudel
Copy link
Collaborator

KittyGiraudel commented Apr 21, 2016

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.

@ffoodd
Copy link
Owner Author

ffoodd commented Apr 21, 2016

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

@ffoodd ffoodd changed the title Hologram + Sassdoc: multi-language? Hologram to Sassdoc, then multi-language? May 12, 2016
@ffoodd ffoodd added the project label Nov 22, 2016
@ffoodd
Copy link
Owner Author

ffoodd commented Oct 9, 2017

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

Note: Infusion became Cupper.

@ffoodd ffoodd removed this from the 4.0 milestone Nov 22, 2017
@ffoodd ffoodd changed the title Hologram to Sassdoc, then multi-language? Documentation: references feeds, multi-language? Nov 23, 2017
@ffoodd
Copy link
Owner Author

ffoodd commented Nov 23, 2017

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
Copy link
Owner Author

ffoodd commented Jan 5, 2018

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

@ffoodd
Copy link
Owner Author

ffoodd commented Nov 12, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: How to
Development

No branches or pull requests

2 participants