Add project: show more yaml examples
#368
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I used tabs to show different examples of YAML files, as suggested in #184. It looks great for an initial interactive approach. I like the tabs over the dropdown because it gives the user a clear idea there are more than Sphinx and MkDocs tools supported, which is a good marketing strategy, in my opinion. It also adds an "Others" option that's more generic and shows how to use `build.commands` in a generic way: install dependencies, build, copy assets under `$READTHDOCS_OUTPUT` directory.
humitos
added a commit
that referenced
this pull request
Jun 6, 2024
I used `highlight.js` to highlight the examples when importing a project. It requires importing a CSS file that I'm not sure where to put it yet. https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/dark.min.css Besides, I need to know where to place the small chunk of JS code that I added to make this work. Based on #368
agjohnson
reviewed
Jun 6, 2024
Co-authored-by: Anthony <[email protected]>
Co-authored-by: Anthony <[email protected]>
agjohnson
reviewed
Jun 6, 2024
|
Final version 🚀
|
agjohnson
approved these changes
Jun 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I used tabs to show different examples of YAML files, as suggested in #184. It looks great for an initial interactive approach.
I like the tabs over the dropdown because it gives the user a clear idea there are more than Sphinx and MkDocs tools supported, which is a good marketing strategy, in my opinion.
It also adds an "Others" option that's more generic and shows how to use
build.commandsin a generic way: install dependencies, build, copy assets under$READTHDOCS_OUTPUTdirectory.