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

Consider using SassDoc #6

Closed
KittyGiraudel opened this issue Oct 16, 2014 · 12 comments
Closed

Consider using SassDoc #6

KittyGiraudel opened this issue Oct 16, 2014 · 12 comments
Assignees

Comments

@KittyGiraudel
Copy link

SassDoc. Just sayin'. :)

@hiulit
Copy link
Owner

hiulit commented Oct 16, 2014

I'm planning on it! ;)

@hiulit
Copy link
Owner

hiulit commented Oct 17, 2014

Am I in the good path?

1174a1e
0b43044
90146b4
1a939a7

@KittyGiraudel
Copy link
Author

Kind of. Let's keep this very simple.

  1. Document your items with SassDoc comments: http://sassdoc.com/annotations/. Feel free to use /// comments if you don't want them to be output in final CSS.
  2. Install SassDoc on your computer: npm install sassdoc -g.
  3. Create a JSON/YML file to configure SassDoc (and its default theme): http://sassdoc.com/customising-the-view/.
  4. Run sassdoc: sassdoc path/to/scss path/to/docs --config path/to/conf.json.

@hiulit
Copy link
Owner

hiulit commented Oct 17, 2014

Already done everything you said ;)

@KittyGiraudel
Copy link
Author

Alright. Then I suggest you put the content of your docs folder in a gh-pages branch so it's online at http://hiulit.github.io/Sassy-Gridlover/. :)

@hiulit
Copy link
Owner

hiulit commented Oct 20, 2014

How do you feel about that? http://hiulit.github.io/Sassy-Gridlover/sassdoc/

@KittyGiraudel
Copy link
Author

How do you feel about that? :)

@hiulit
Copy link
Owner

hiulit commented Oct 20, 2014

Hahaha! I feel alright!
But I have the feeling that I still have to master SassDoc...
How can I reorder the menu, to have the variable appear before the mixins? Like: http://minamarkham.github.io/sassy-starter/docs/ for example?
Do you have any ideas on how to improve my docs?

@KittyGiraudel
Copy link
Author

You cannot. Ordering things is still not very intuitive on SassDoc.

To improve your docs:

  • add basePath (docs)
  • add CSS @example to show CSS output from SCSS @example perhaps

@hiulit
Copy link
Owner

hiulit commented Oct 20, 2014

Alright, thanks! :)
I'll be closing this issue then.

@hiulit hiulit closed this as completed Oct 20, 2014
@hiulit
Copy link
Owner

hiulit commented Oct 20, 2014

Btw, how can I include "Sassy-Gridlover" http://hiulit.github.io/Sassy-Gridlover/sassdoc/ to "Built with SassDoc" http://sassdoc.com/built-with-sassdoc/?

@hiulit hiulit self-assigned this Oct 20, 2014
@KittyGiraudel
Copy link
Author

You can submit a PR to https://github.com/sassdoc/sassdoc.github.io. :)

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

No branches or pull requests

2 participants