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.

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

createBookFromReadme.sh doesn't work #96

Open
ilyakmet opened this issue Dec 19, 2020 · 1 comment
Open

createBookFromReadme.sh doesn't work #96

ilyakmet opened this issue Dec 19, 2020 · 1 comment

Comments

@ilyakmet
Copy link

macOS 10.15.7

bash createBookFromReadme.sh
2020-12-19 14:48:44 [WARN] (mdbook::book::summary): Expected a start of a link, actually got Some(Text(Borrowed("[")))
2020-12-19 14:48:44 [ERROR] (mdbook::utils): Error: Summary parsing failed
2020-12-19 14:48:44 [ERROR] (mdbook::utils): 	Caused By: There was an error parsing the numbered chapters
2020-12-19 14:48:44 [ERROR] (mdbook::utils): 	Caused By: There was an error parsing the numbered chapters
2020-12-19 14:48:44 [ERROR] (mdbook::utils): 	Caused By: failed to parse SUMMARY.md line 3, column 3: The link items for nested chapters must only contain a hyperlink
@FongYoong
Copy link

image

As shown above, I had the same issue too.
Clearly, the problem lies in mdbook build.

The createBookFromReadme.sh script consists of multiple build functions and it fails at buildAndServeBookLocally due to the mdbook build error as illustrated below:

image

Inspecting the SUMMARY.md file generated by createBookFromReadme.sh, we find that the highlighted line is the root cause of this issue. In fact, it's actually the first line of README.md:

image

To overcome this, we can add an Update heading to the start of README.md.
image

Hope it solved your issue.

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

No branches or pull requests

2 participants