-
Notifications
You must be signed in to change notification settings - Fork 61
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
🖌 Add aside
,margin
and sidebar
directives
#1012
Conversation
66da65f
to
b688080
Compare
@rowanc1 made a good point regarding the interpretation of the AST for a sidebar/margin. Really, these form "asides" which may have subtypes e.g. sidebar. I've defined a new |
b688080
to
58eae81
Compare
58eae81
to
9071c59
Compare
docs/asides.md
Outdated
````{myst} | ||
The main article contains main-article text! | ||
|
||
```{aside} | ||
This is an aside. It is not entirely relevant to the main article. | ||
``` | ||
```` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one might be easier to start from the jupyter-books docs on this and demonstrate it in the page rather than in a demo component?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think an aside
should be a MyST feature, but I would not be surprised if aside
isn't very clear in the demo component. We can enable a grid layout on the MyST demo component if needs be.
Welcome your thoughts here if you think it would be better not to use the myst
directive and instead include the aside
in the main guide body. But, I think we can fix-up the demo component to make it possible to see, probably.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: aside directive | ||
cases: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the tests!
"myst-directives": minor | ||
--- | ||
|
||
Add `aside` directive |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
41d55a8
to
aa7fa2e
Compare
aside
directiveaside
,margin
and sidebar
directives
This PR replaces #1010 with an
aside
directive, renamingmargin
, e.g.There is also the
margin
alias, andsidebar
which has a differentkind
.