RescriptusStart writing

Help

Connecting GitHub

Sign in with GitHub, choose which repository holds your book, and disconnect when you are done.

Rescriptus can save your project into a GitHub repository that you choose. It can see only the repositories you give it.

Connect

  1. Open Settings (the gear button). On the storage page, find GitHub.
  2. Choose Sign in with GitHub. GitHub asks you to sign in and to allow the Rescriptus app. Your GitHub password goes to GitHub, never to us.
  3. GitHub asks which repositories the app may open. A new, private repository of its own is best.
  4. You come back to Rescriptus. It shows "Signed in as" your username and lists the repositories you allowed, marked private or public.

If you do not have an account, there is a link to make one. It is free.

Choose your project

  1. Click a repository in the list.
  2. Optional: open Advanced: branch and folder. The branch is filled in with the repository's default. The folder is empty by default, which uses the whole repository. Type a name such as novel to keep the project in a folder instead.
  3. Choose Use this repository.

An empty repository works. Rescriptus makes the first commit for you.

Rescriptus treats every Markdown file in the repository (or folder) as part of your project. If the repository holds other things too, give Rescriptus a folder so it does not mix them up.

What is stored where

  • Your writing: in the repository you chose. It goes there straight from your browser.
  • A working copy: in this browser, so pages open quickly and unsent edits survive a dropped connection. See Privacy and your files.
  • Your choice of repository, branch and folder: in this browser only. On a new device, sign in and choose again.

Switching repository

Choose another repository on the same page. Anything waiting on this device is sent to the current repository first. If something cannot be sent, Rescriptus tells you and keeps it, for when you switch back.

Disconnect

Two buttons sit beside your GitHub details.

  • Disconnect signs this browser out of GitHub and removes your project from this device: the offline copy, anything not yet sent, and any recovered text. Your files on GitHub are not touched.
  • Disconnect and remove access does the same, and also removes Rescriptus's access to your GitHub account. You can grant it again by connecting.

If anything has not reached GitHub yet, Rescriptus says so first. You can send it, download it, or choose to delete it.

If sign-in fails

The page says "GitHub sign-in didn't finish. Try again." Choose Sign in with GitHub again. If it keeps failing, check that your browser allows cookies for this site.