Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Where is the authors field used (and was there ever an author field?) #2623

Open
szabgab opened this issue Mar 28, 2025 · 2 comments
Open

Where is the authors field used (and was there ever an author field?) #2623

szabgab opened this issue Mar 28, 2025 · 2 comments
Labels
C-question Category: A question on how to do something

Comments

@szabgab
Copy link
Contributor

szabgab commented Mar 28, 2025

Question

As I analyzed several public mdbooks I found a few books with a field called author containing a string. I wonder, was there a field like that earlier?

Also I don't see where mdbook uses the authors field. Is it used?
Maybe its content should be added to the generated html file as a comment or in the header of the html page? <meta name="author" content="John Doe">

Version
@szabgab szabgab added the C-question Category: A question on how to do something label Mar 28, 2025
@ehuss
Copy link
Contributor

ehuss commented Mar 28, 2025

In the past there was some incorrect documentation which led to the inconsistency, see #1804.

I don't think it has ever been used for anything, but I'm uncertain about plugins/renderers.

@szabgab
Copy link
Contributor Author

szabgab commented Mar 28, 2025

Thanks. Then I'll send PRs to those project to change the field to authors.

This was referenced Mar 28, 2025
Merged
Merged
Open
Merged
Open
Open
github-merge-queue bot pushed a commit to rust-lang/cargo that referenced this issue Apr 1, 2025
@weihanglo
rename the author field to be authors in book.toml (#15362)
c5f58e9 
See the [mdbook
documentation](https://rust-lang.github.io/mdBook/format/configuration/general.html)
Apparently the `author` was field was [incorrect
documentation](rust-lang/mdBook#2623)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-question Category: A question on how to do something
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ehuss @szabgab