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

Concatenate sections #17

Closed
SammyM opened this issue Mar 13, 2015 · 2 comments
Closed

Concatenate sections #17

SammyM opened this issue Mar 13, 2015 · 2 comments

Comments

@SammyM
Copy link

SammyM commented Mar 13, 2015

Would it be possible to concatenate sections which have the same titles of the following format?:

/***
 * Buttons
 */

I have button styles in different files and I would like to add them all to the same section instead of having multiple sections with the same title in different locations within the style guide.

@nickisnoble
Copy link

I tend to write all my docs for a section at the top of the file. (I'm using scss, so in this case it would be something like _buttons.scss.

Then my example block would look something like this:

@example
a.button This is a button
a.button.primary This is an action button
a.button.secondary This is a secondary action button
a.button.cancel This is a cancel button

It will all render ok even if the styles come later or in a different file, because the output is static (so it uses the whole stylesheet(s) anyway, so long as it/they are included in config.md).


Otherwise, if you generate your documentation from a Markdown file rather than css comments, you can have them all in one section. I like doing it this way, having the docs be separate is a little better for organization, and my team likes it because they can edit the copy, if need be, without dealing with real code.

@SammyM
Copy link
Author

SammyM commented Mar 31, 2015

Okay, thank you.

@SammyM SammyM closed this as completed Mar 31, 2015
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

No branches or pull requests

2 participants