Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 2.51 KB

README.md

File metadata and controls

23 lines (20 loc) · 2.51 KB
Raw

GitBook Sushi Card Series Template

This is a template for creating a Sushi Card series in GitBook. You can find instructions for creating a GitBook based on it here.

Once you've followed all those instructions, you'll need to follow the instructions below on how to configure this template for your use.

Configuring the template

You need to do the following to get everything setup properly:
watch a video that walks through this setup

  1. Click on the black triangle at the top-right of the GitBook editor window and select Edit Book Configuration. Modify the seriesSubject variable (do not translate the name of this or any other variable) to match the subject you're writing about. Check out the list of subjects and, if you can't find a match, request it gets added to the theme by adding a new issue.
    Make sure you do this. The theme expects a valid value here and will break in a few places without it.
  2. You now need to switch into the Files view. From there, navigate to en/book.json and make the following changes:
    • Change the value of title to the title of your Sushi Card Series
    • Change the value of seriesTitle in variables to the same title of your Sushi Card Series
  3. I have created this template on the assumption that you are writing in English. If so, you can skip this step. If you are writing in any other language, you will need to make a few more small changes:
    • In en/book.json change the value of language from en to the correct two letter code for the language you are writing in, chosen from the ISO 639-1 list
    • If the language you're writing in is read right-to-left, then in en/book.json Change the value of the direction variable from ltr (left-to-right) to rtl (right-to-left)
    • Right-click on the en folder and choose Rename. Name it with the same two letter code you used above
    • Open LANGS.md and replace English with the name of your language and en with the two letter code you used above
  4. You're done! You're ready to start writing Sushi Cards. You might still want to check out: