Skip to content

Document shortcodes#28

Merged
stefanv merged 1 commit intoscientific-python:mainfrom
jarrodmillman:shortcode-docs
Oct 20, 2021
Merged

Document shortcodes#28
stefanv merged 1 commit intoscientific-python:mainfrom
jarrodmillman:shortcode-docs

Conversation

@jarrodmillman
Copy link
Member

@jarrodmillman jarrodmillman commented Oct 20, 2021

@stefanv I wasn't sure how to make the shortcode markdown visible. I ended up copying the shortcode examples and, on the first copy, I surrounded the block with three backticks (only really needed when there is markdown inside the block, e.g., youtube transcript) and then putting the shortcode command inside /* <shortcode command> */. You will see what I mean.

Maybe there should be a shortcode for wrapping shortcode examples. It would print the text as is with the output below it. Maybe the command could be collapsible.

@jarrodmillman jarrodmillman requested a review from stefanv October 20, 2021 18:31
@jarrodmillman
Copy link
Member Author

jarrodmillman commented Oct 20, 2021

@stefanv stefanv merged commit f7d7cd4 into scientific-python:main Oct 20, 2021
@jarrodmillman jarrodmillman deleted the shortcode-docs branch May 2, 2022 16:11
@jarrodmillman jarrodmillman added this to the 0.1 milestone Sep 29, 2023
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.

2 participants