1
0
mirror of https://github.com/becarpenter/book6.git synced 2024-05-07 02:54:53 +00:00
This commit is contained in:
Brian E Carpenter
2022-09-19 08:26:48 +12:00
committed by GitHub
parent 46d9a804da
commit 0a2835a64a

View File

@ -4,7 +4,7 @@ This chapter shows how to write a new chapter. It is intentionally listed in the
The second section in this chapter shows how to write a new section.
We use the GitHub dialect of Markdown. There is some information about this in the[<ins>Markdown Usage</ins>](Markdown%20Usage.md) section below, including how to include diagrams.
We use the GitHub dialect of Markdown. There is some information about this in the [<ins>Markdown Usage</ins>](Markdown%20Usage.md) section below, including how to include diagrams.
The first line in this file is:
@ -39,7 +39,7 @@ create such links automatically, and reconcile differences between the actual ch
It does some other things as well, to help authors:
1. If it find a chapter in the main contents, but there is no corresponding chapter directory, it creates the latter with appropriate template files that the author(s) can edit.
1. If it finds a chapter in the main contents, but there is no corresponding chapter directory, it creates the latter with appropriate template files that the author(s) can edit.
2. If it finds a section in a chapter introduction, but there is no corresponding Markdown file, it creates such a file. The author only has to add the content
@ -48,7 +48,7 @@ it adds it to the list of contents.
4. It automatically inserts links at the bottom of each section pointing to the previous and next sections (if they exist) and back to the chapter introduction.
makeBook has to be run on the main Github branch from time to time. At this writing, there is no practical experience with this - patience, please. If it goes wrong, there is nothing that can't be fixed manually. The main rule is: don't mess with the automatically generated links.
makeBook has to be run on the main Github branch from time to time. At this writing, there is limited practical experience with this - patience, please. If it goes wrong, there is nothing that can't be fixed manually. The main rule is: don't mess with the automatically generated links.
So, to repeat: add a new ## item to the chapter introduction, and makeBook will create the necessary .md file. Add a new .md file to the chapter directory, and makeBook will add it to the chapter contents.