Don't use quotes for user-entered YAML entries #305
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
Because we used to wrap page title entries with quotes in YAML front-matter, pages with a quote in the name would cause Jekyll to error out ([like this page titled "What's in a name?"][1]). This commit uses [YAML Block Scalars][2] to give users the greatest flexibility when naming book sections. Section names can now contain single quotes, double quotes, and colons. To test this: 1. I edited `jupyter_book/book_template/_data/toc.yml`, changing the page titled `Jupyter notebooks` to `"Sam's Cool Title: Notebooks!"`. I verified that building the website does not break at either `jupyter-book build` or the `jekyll build` step. 2. I opened http://127.0.0.1:4001/jupyter-book/features/notebooks.html and verified that the sidebar had the updated title. 3. I opened http://127.0.0.1:4001/jupyter-book/features/hiding.html and verified that the previous page button at the bottom of the page had `Sam's Cool Title: Notebooks!` as the previous page's title. [1]: https://www.textbook.ds100.org/ch/01/lifecycle_students_3.html [2]: http://blogs.perl.org/users/tinita/2018/03/strings-in-yaml---to-quote-or-not-to-quote.html
choldgraf
reviewed
Sep 6, 2019
|
One small nit to add a comment for context in the future, then I think this looks good to me! |
Co-Authored-By: Chris Holdgraf <[email protected]>
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.
Because we used to wrap page title entries with quotes in YAML
front-matter, pages with a quote in the name would cause Jekyll to error
out (like this page titled "What's in a name?").
This commit uses YAML Block Scalars to give users the greatest
flexibility when naming book sections. Section names can now contain
single quotes, double quotes, and colons.
To test this:
jupyter_book/book_template/_data/toc.yml, changing thepage titled
Jupyter notebooksto"Sam's Cool Title: Notebooks!".I verified that building the website does not break at either
jupyter-book buildor thejekyll buildstep.and verified that the sidebar had the updated title.
verified that the previous page button at the bottom of the page had
Sam's Cool Title: Notebooks!as the previous page's title.