-
Notifications
You must be signed in to change notification settings - Fork 279
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
Support for preprocessor functions and mixins #22
Comments
I would like to add this from Each documentation block should have a description section, parameters section, and compatibility section. The description section follows the same guidelines as style documentation. The parameters section If the mixin takes parameters, you should document each parameter and describe what sort of input it expects (hex, number, etc). // $start - The color hex at the top. You must list out what browsers this helper method is compatible in. // Compatible in IE6+, Firefox 2+, Safari 4+. // Compatibility untested. |
Just an update, with 0.3.6: modifiers are coming through as paragraphs, as are compatibility sections. |
I would just like to add that LESS mixins are not parsed correctly either. The entire parameters section just turns into a single line of text. |
+1 - I'm seeing this too. |
I found that adding Example:
|
👍 |
Hello, I too ran into this issue, my parameters output on one line as a paragraph. I use Sass, is there a workaround for Sass users? Thanks. |
Oh! I was trying to figure out how to get kss-node to tell the difference between a preprocessor helper docblock and a regular docblock. And I think that's the key! If the docblock has a block that looks like modifiers, but has no markup block, then kss-node can display those as parameters instead of modifiers. |
👍 |
Fixed! |
Thanks :) - Is there any chance this could be published to npm before the full 2.0 checklist todo is done? I'll install from the repo for now: |
@MadLittleMods You dont need to wait for the final v2 release, just wait till "2.0.0-alpha.5" |
I just tried the latest code and it doesn't seem to work. I am using Sass scss. Installed via: I grabbed this example from the gh-pages demo, also on the KSS site
The only way I can get it to parse is if I add a In that example, kss-node uses the description as the the If I add a a header(which is repetitive because it is right there in the mixin), then it lumps the description, parameters, and compatibility into the Should it work without a header? Also there is a |
FYI, I'm using this feature already on a production web site. It's included with https://github.com/kss-node/kss-node/releases/tag/v2.0.0-beta.1 I've already opened a github discussion in the kss queue about the problem with showing a preprocessor example that doesn't have a The latest docs I wrote for kss-node v2 include an annotated spec at https://github.com/kss-node/kss/blob/spec/SPEC.md . That spec is clearly noted in the README, but won't appear on the kss-node homepage until v2 is released and the master branch becomes the default branch (instead of 1.x.) That will happen sometime in the next week. |
It seems like mixins and functions, at least in SASS/SCSS, aren't parsed correctly.
Take the following simple block :
As
kss-node
is interpreting the arguments as modifiers, it doesn't display them without a provided markup.Mixins and functions shouldn't have any markup – ever – and thus the parser should skip straight to the modifiers and display them as arguments.
The text was updated successfully, but these errors were encountered: