You will first need to register a GitBook account, or sign in with GitHub or Google, if you haven't already got one.
Files and images
Adding a Sushi Card
If you add a file as in the video above, you will need to manually add it to the Summary (see below) for it to be included in the series.
Alternatively, if you click "TOC" and "Add an article", GitBook will do this for you automatically (and you don't need to include ".md" in the name).
- Note: when you add an article, GitBook does not create a file until you actually start typing in the editor
You can edit the title of a card by clicking on the little pencil icon. The name of the underlying .md file will remain the same.
You can also reorder the cards by simply clicking and dragging a title to a new location in the list.
Adding an image
The Sushi template expects image files to be in a folder called "assets", which should be located inside the "en" (or other language) folder.
Your best bet is to click "FILES", right click on the "en" folder (or equivalent folder for your language) and select "New Folder" to create the "assets" folder in the correct location.
Then, to add an image:
- Right click on the "assets" folder and select "Import File..."
- Select the file to upload from your computer
- In the text editor for your Sushi Card, insert the image
To insert an image you've uploaded into a Sushi Card you can either:
- Use the "Insert Image" icon and select the file from the Library
- Edit the markdown and use the markdown code
If you insert an image using the "Insert Image" feature and select "From Computer" to upload the file in the same step, GitBook creates an "assets" folder outside of the "en" folder. You will need to manually move the folder or the file to the correct location in this case.
Working with the TOC/Summary
The included pages and their order are defined in a file called "SUMMARY.md" which you will find in the "en" folder (or the equivalent folder for your language).
Each item in the bullet list is a separate article i.e. Sushi Card.
Each item is a hyperlink: the text shown is the title that will appear on the card (and in the Table of Contents), e.g. "Your first program", and the URL of the link is the name of the underlying file, e.g. "your-first-program.md".
If editing this file you may wish to switch to editing markdown for more control over editing the links.