Any edits, comments, or questions or if you want to make contributions please make a pull request, raise an issue - or request Fidus Writer edit access. Contact: Simon Worthington, https://github.com/mrchristian

What you will learn here

1. To connect two programmes together: Fidus Writer and Github

2. Export your book to GitHub

3. A GitHub workflow

4. To setup a collaborative work environment

5. How to manage changes to a book from multiple contributors

Setup: 3 steps

1. Connecting GitHub account to Fidus Writer

• Create or use a GitHub account

• Add your user account via the profile area, click your profile button - top right

• In the section 'Add Social Provider' input your account details and follow instructions in diaglogs from GitHub. This process will allow Fidus Writer to access your GitHub account services and export books.

• You can now return to your book

2. Select GitHub repository to export to

• Make a repository on GitHub

• Click on your book in Fidus Writer and open the book information panel

• Select the repository that you made as the repository to export your book to

• Choose the export format options: HTML, EPUB, expanded EPUB, etc.

• Close the book dialog box and your book is now ready for export.

3. Export book to GitHub

• Navigate to the book list in the Fidus Writer Books area and select the tickbox to left of the book

• Once the book tickbox is selected then from drop down menu at top - select export to Github - your book will now be exported to GitHub. A dialog box bottom right will give information on the export status.

• Navigate to GitHub to view the export results.

  The GitHub Workflow

  This examples covers how to work with several co-authors on one book, where style additions will be made on GitHub. Note content issues are not made on GitHub - only on Fidus Writer (at present 4.2021).

  Contributors here will only work on styles: CSS, HTML or XHTML if needed, and assets like images and fonts.

  1. Book is exported my Editor in Chief to publishing repo

  2. Editor in Chief creates 'design' branch

  3. Contributors fork 'publishing' repo and in their own repo create branch in their name 'name-design'

  4. Design work should be done on the branch.

  5. GitHub pages can be set to render branch.

  6. Contributor can keep their main up-to-date from publishing repo using Pull Requests, and further update their branch if needed, being careful to not overwrite their own changes.

  7. Contributor can make Pull Requests back to publishing repo to the design branch.

  8. Editor-in-Chief will accept Pull request into design branch, or reject, or add to a new branch in name of designer. At end Editor-in-Chief will commit to main.