allow custom index title #342
Merged
Conversation
This file contains 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
|
@SaraMorsy, could you test this PR out and see if it works for your lesson? To your sandpaper: carpentries/sandpaper@allow-custom-title-340You should be able to add this to your |
|
It worked nicely and better than doing it manually. Thank you! |
|
That's good to hear! You should be able to now remove the |
ns-rse
added a commit
to Romain-Thomas-Shef/FAIR24RS_Software_lifecycle_planning
that referenced
this pull request
Sep 18, 2024
I actually went and read the commit that introduced the use of custom titles in `index.md` as I should have done in the first instance and a tweak needs to be made to `config.yaml` (see [342](carpentries/sandpaper#342 (comment))) which is included in this commit. However, testing I found that we couldn't have just a YAML header in `index.md` this caused the error... ``` ── Creating homepage ─────────────────────────────────────────────────────────── Error in UseMethod("xml_find_first") : no applicable method for 'xml_find_first' applied to an object of class "xml_document" ``` I've therefore moved the opening paragraph from `learners/setup.md` > `index.md` and it seems to work. Took the opportunity to improve a few other minor things (there was a complaint about the use of an uninformative `here` as the text for a hyperlink). This time I've checked _before_ making a pull request and the pages render as we would like.
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.
This update allows authors to specify a custom
titleyaml item inindex.mdto override the default"Summary and Setup" in the case where a setup is not needed for the lesson.
This will fix #340 and address #339