This page is part of a static HTML representation of the TiddlyWiki at

Improving TiddlyWiki Documentation

 13th March 2024 at 11:48am

Anyone can submit improvements to the TiddlyWiki documentation that appears on (For improvements to the core code a more complicated process must be used because of the need to test the changes both in the browser and under Node.js before submission).

If you already know GitHub, note that documentation updates must be directed to the tiddlywiki-com branch

Before you start editing

  1. Read and observe the Documentation Style Guide
  2. Create an account on if you don't already have one
  3. If you haven't done so already, sign the Contributor License Agreement as described in Signing the Contributor License Agreement

Editing and submitting your edits

You can choose to edit the documentation using the TiddlyWiki Docs PR Maker or directly in GitHub. The first method is especially recommended for users not familiar with GitHub.

Using Docs PR Maker edition

  1. Go to or click the link displayed in the ribbon underneath the title when editing a tiddler on
  2. Go through the quick introduction where you will need to provide your GitHub username and a GitHub access token (you will be guided in creating one)
  3. Edit or create tiddlers to update the documentation, the wiki will keep track of all changes
  4. Click the "Submit updates" button and check if all the tiddlers that you edited are included in the submission; if not, drag them into the box
  5. Provide a concise title and description of your changes (see the rules about titling pull requests in contribution guidelines)
  6. Submit your changes:
    • "Save as draft" will create a draft pull request, this is useful if you don't want the changes to be merged yet, because you want to work on it later or discuss it first
    • "Submit documentation update" will create a pull request, which will be immediately available for review and merging

Using GitHub

  1. On, click "edit" on the tiddler you want to improve
  2. You should see a pink banner with the text: Can you help us improve this documentation? Find out how to edit this tiddler on GitHub
  3. Click on the external link ...this tiddler on GitHub
    1. You will be prompted that "you need to fork this repository to propose changes". A "fork" is your own copy of the repository that incorporates the changes you are proposing
  4. A new browser tab should open ready to edit the tiddler on
  5. Below the edit box for the tiddler text you should see a box labelled Propose file change
  6. Enter a brief title to explain the change (eg, "Clarify attribute syntax instability")
  7. If necessary, enter a longer description too
  8. Click the green button labelled Propose file change
  9. On the following screen, click the green button labelled Create pull request

Jermolene or one of the other core developers will then have the opportunity to merge your pull request so that it is incorporated into the next build of

Mario Pietsch has created these short video tutorials: