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

Reactivate Sassdoc, clean up docs build #28

Merged
merged 12 commits into from
Nov 3, 2016

Conversation

davidknezic
Copy link
Contributor

This reintroduces SassDoc, after the fix of interpolated selectors.

screen shot 2016-10-31 at 09 18 31

However, our API section currently looks very chaotic and isn't probably easy to use as a developer reference.

How about we display the items Classes, CSS Utilities, Mixins and jQuery Plugins under the API menu item? Then each of these items is a very long page containing all of the corresponding docs. This allows for a quick search using the browser-search.

@elessar-ch
Copy link
Contributor

We could even put all the classes utilities and so on into one page. Might be a bit long though.
A page-navigation with anchors might be good in either case.

@davidknezic
Copy link
Contributor Author

@elessar-ch do you have any clue, why the example doesn't get rendered properly in the image above? Also, is it normal that there's that weird indentation in the source code?

@FKSI
Copy link
Contributor

FKSI commented Oct 31, 2016

+1 with @elessar-ch I'd love to have all utilities on a single page even thought it might be a little long.

@davidknezic davidknezic changed the title Reactivate Sassdoc Reactivate Sassdoc, clean up docs build Nov 2, 2016
@davidknezic
Copy link
Contributor Author

Related SassDoc/scss-comment-parser#25

@davidknezic
Copy link
Contributor Author

Ready to review. I think the fix for SassDoc can be done at a later point, I'll add an issue.

@davidknezic
Copy link
Contributor Author

This pr also remove a LOT of old code for pug and markdown parsing. There were also lots of unneeded dependencies.

@@ -269,7 +204,10 @@ metalsmith.destination('./dist/docs/')
// Function to run the magic
metalsmith.build((err) => {
if (err) {
// eslint-disable-next-line no-console
console.log((new Date()).toLocaleTimeString(), 'Failed!', err)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about switching to console.err() aren't they made for that?

Copy link
Contributor

@FKSI FKSI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try faster

@davidknezic davidknezic merged commit 9c51a94 into master Nov 3, 2016
@davidknezic davidknezic deleted the feature/reactivate-sassdoc branch November 3, 2016 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants