Skip to content

Creating & editing chapters

Nick Floyd edited this page May 24, 2016 · 3 revisions

Chapters in the book represent a complete though or pathway to another (consider this while you're thinking about where to put your chapter). They are generally 10-20 pages long and begin with a title and image to help anchor the reader.

Note: All text-based content in this book uses markdown for formatting. Since the book is always published to Leanpub first I generally try to go by the docs they provide as a great starting point when wanting to format my content.

Adding content to existing chapters

  1. This is simply putting text on the page
  2. Make sure to check things like spelling, grammar and external links
  3. Always give credit for sources - they worked hard to generate content, we should honor that work.
  4. Submit a Pull Request

Adding new chapters:

  1. Add a file to the manuscript folder and name it chapter#.txt where # is the sequential number of chapter in the book.
  2. All chapters start with # The Chapter Name where "The Chapter Name" is the name of your chapter (remember to name it something fun!)
  3. All chapters have a header image following the Chapter name using ![](images/ch#.jpg) where the title image is 650px x 650px at 300 dpi or greater
  4. Add content and links to your new chapter - these are generally 10-20 pages long, but don't let that keep you from committing your thoughts (that's kinda what's collaboration is all about).
  5. Finally add your new chapter (once finished) to Book.txt, Sample.txt and Subset.txt
  6. Submit a Pull Request