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

macro documentation [WIP] #34

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

macro documentation [WIP] #34

wants to merge 1 commit into from

Conversation

mirisuzanne
Copy link
Member

document macros directly in the j2/njk markup, using sassdoc-like annotations

@davisagli
Copy link
Contributor

How are you thinking we would tell sassdoc to scan for this? Would we reference a particular njk file or macro from within a Sass file? Or would we want herman to find all the njk files in a list of paths and create a new page in the documentation for each one that contains annotations (thus making documentation in templates more of an equal peer to documentation in sass rather than secondary)?

@mirisuzanne
Copy link
Member Author

My thought was that we pass a nunjucks folder to scan, similar to the Sass — and add the documentation to @group pages in a similar way (not based on file or path). Basically, the equal peer option.

@davisagli
Copy link
Contributor

Cool, that's my preference too in terms of functionality. I'll have to look at whether we can implement it without changing sassdoc itself.

@mirisuzanne mirisuzanne modified the milestone: Herman 1.0 May 21, 2017
@wlonk wlonk modified the milestone: Herman 1.0 May 22, 2017
@jgerigmeyer jgerigmeyer added stale and removed WIP labels Nov 17, 2017
@jgerigmeyer jgerigmeyer changed the base branch from master to main January 4, 2021 22:23
@davisagli davisagli removed their assignment Jul 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants