Comments (12)
I'm planning on it! ;)
from sassy-gridlover.
Am I in the good path?
1174a1e
0b43044
90146b4
1a939a7
from sassy-gridlover.
Kind of. Let's keep this very simple.
- 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. - Install SassDoc on your computer:
npm install sassdoc -g
. - Create a JSON/YML file to configure SassDoc (and its default theme): http://sassdoc.com/customising-the-view/.
- Run
sassdoc
:sassdoc path/to/scss path/to/docs --config path/to/conf.json
.
from sassy-gridlover.
Already done everything you said ;)
from sassy-gridlover.
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.
How do you feel about that? http://hiulit.github.io/Sassy-Gridlover/sassdoc/
from sassy-gridlover.
How do you feel about that? :)
from sassy-gridlover.
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.
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.
Alright, thanks! :)
I'll be closing this issue then.
from sassy-gridlover.
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.
You can submit a PR to https://github.com/sassdoc/sassdoc.github.io. :)
from sassy-gridlover.
Related Issues (17)
- Using em instead rem HOT 11
- something is odd here HOT 4
- Line Heights with Ems HOT 4
- NPM Package? HOT 2
- Create a Stylus port
- Create a Less port
- Rewrite $step3 on sgl-heading mixins ? HOT 7
- Use !default in your variables _config.scss HOT 6
- dart-sass: deprecation warning: !global assignments won't be able to declare new variables HOT 3
- Default export HOT 7
- Error: Invalid null operation: "null times 2.36859" HOT 11
- npm publish HOT 3
- Don't append unit HOT 3
- Use pow() when available
- Consider constant naming conventions HOT 2
- use less generic functions names HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sassy-gridlover.