This GitBook; editing it, etc

What is GitBook? How to edit it?

See my notes on another GitBook here, on how to edit it, etc.

Some quick points:

  • GitBook is mainly used for tech documentation; but it has some important strengths and it's pretty good for general use.

  • It is based in markdown and other simple flat text files.

  • It synchronizes through Git/Github, and you can push and pull ... but you can also select "edit" and "merge" and use it fairly WYSIWYG.

  • They have a good support team (try their chat/help button).

Also consider our 'style guide' linked here (for this and other communications)

Shortcut for switching between public and private versions of the same page

18 Jun 2023 -- needs moving after moving GitBook location

Switching between the public and private versions of GitBook (while maintaining the same relative page) is a pain.

Semi-automate: going from the editable to the public version with a 'bookmarklet'

Setting the following as a ‘bookmark’ seems to help (Chrome: bookmarks manager, edit any existing bookmark by right click --> edit)

Name: “Switch to Public GitBook page” (or whatever)

URL: set to:

To go in the other direction (public to editable version of a page)

Setting the following as a "bookmark" seems to help (chrome: bookmarks manager, edit any existing bookmark by right click --> edit)

Name: “Switch to Editable GitBook page” (or whatever)

URL: set to:

Last updated

Was this helpful?