GithubHelp home page GithubHelp logo

Consider using SassDoc about sassy-gridlover HOT 12 CLOSED

hiulit avatar hiulit commented on June 11, 2024
Consider using SassDoc

from sassy-gridlover.

Comments (12)

hiulit avatar hiulit commented on June 11, 2024

I'm planning on it! ;)

from sassy-gridlover.

hiulit avatar hiulit commented on June 11, 2024

Am I in the good path?

1174a1e
0b43044
90146b4
1a939a7

from sassy-gridlover.

KittyGiraudel avatar KittyGiraudel commented on June 11, 2024

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.

from sassy-gridlover.

hiulit avatar hiulit commented on June 11, 2024

Already done everything you said ;)

from sassy-gridlover.

KittyGiraudel avatar KittyGiraudel commented on June 11, 2024

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/. :)

from sassy-gridlover.

hiulit avatar hiulit commented on June 11, 2024

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

from sassy-gridlover.

KittyGiraudel avatar KittyGiraudel commented on June 11, 2024

How do you feel about that? :)

from sassy-gridlover.

hiulit avatar hiulit commented on June 11, 2024

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?

from sassy-gridlover.

KittyGiraudel avatar KittyGiraudel commented on June 11, 2024

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

from sassy-gridlover.

hiulit avatar hiulit commented on June 11, 2024

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

from sassy-gridlover.

hiulit avatar hiulit commented on June 11, 2024

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

from sassy-gridlover.

KittyGiraudel avatar KittyGiraudel commented on June 11, 2024

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

from sassy-gridlover.

Related Issues (17)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.