Skip to content

Create scss-docs shortcode to get some snippets from the Scss source files#30502

Merged
MartijnCuppens merged 5 commits intomasterfrom
master-mc-scss-docs
Apr 6, 2020
Merged

Create scss-docs shortcode to get some snippets from the Scss source files#30502
MartijnCuppens merged 5 commits intomasterfrom
master-mc-scss-docs

Conversation

@MartijnCuppens
Copy link
Member

@MartijnCuppens MartijnCuppens commented Apr 2, 2020 •
edited
Loading

This should be a little bit easier that creating a custom regex per case.

Usage in .scss:

// scss-docs-start awesome-code
.my-awesome-code {
  // The best CSS in the world
}
// scss-docs-end awesome-code

In the docs files:

{{< scss-docs name="awesome-code" file="scss/_variables.scss" >}}

I don't think the positive lookbehind syntax works in Hugo, so I replaced the comments in the end of the file, there are probably better ways to fix this (bump @XhmikosR)

TODO:

  • Check all occurrences of code snippets
  • Strip !default flags by default

@MartijnCuppens MartijnCuppens requested a review from a team as a code owner April 2, 2020 20:10
@mdo
Copy link
Member

mdo commented Apr 2, 2020

Oh you brilliant son of a bucket, that's rad. This is fresh as hell.

@ffoodd
Copy link
Member

ffoodd commented Apr 3, 2020

I love this, it'll make things so much easier!

@MartijnCuppens
Copy link
Member Author

MartijnCuppens commented Apr 3, 2020

Neither the positive lookbehind syntax nor grouping seem to be supported in Hugo regex, so the replacing the comments seems to be the way to go.

Ready for review!

@XhmikosR
Copy link
Member

XhmikosR commented Apr 3, 2020 via email

@MartijnCuppens MartijnCuppens requested a review from XhmikosR April 3, 2020 16:50
@MartijnCuppens MartijnCuppens mentioned this pull request Apr 5, 2020
Merged
5 tasks
mdo
mdo approved these changes Apr 6, 2020
View reviewed changes
Copy link
Member

@mdo mdo left a comment

Choose a reason for hiding this comment

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

This looks lovely to me, so adding an approval for whatever it's worth :).

@MartijnCuppens MartijnCuppens merged commit 83b49aa into master Apr 6, 2020
@MartijnCuppens MartijnCuppens deleted the master-mc-scss-docs branch April 6, 2020 18:13
@MartijnCuppens MartijnCuppens mentioned this pull request Apr 7, 2020
Closed
olsza pushed a commit to olsza/bootstrap that referenced this pull request Oct 3, 2020
@MartijnCuppens @XhmikosR @olsza
Create scss-docs shortcode to get some snippets from the Scs… (twbs…
423f25c 
…#30502)

Co-authored-by: XhmikosR <xhmikosr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mdo mdo mdo approved these changes

@XhmikosR XhmikosR XhmikosR approved these changes

Assignees

No one assigned

Labels

css docs v5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@MartijnCuppens @mdo @ffoodd @XhmikosR