Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 1.8 KB

README.md

File metadata and controls

18 lines (15 loc) · 1.8 KB
Raw

TW5-github-actions-example

Example of how to use Github Actions to build and publish a TiddlyWiki

Once configured, every time you push changes to your repository, an updated TiddlyWiki file will be built and published at a public URL.

Starting point: a wiki folder for TiddlyWiki on node.js, being saved to a Github repository.

In the root of your repository you need to:

  • add a package.json file. You can do so via npm using npm init, or by copying and modifying the package.json in this repo.
  • add TiddlyWiki as a dependency npm install tiddlywiki
  • Add a script build to your package.json file by copying from the package.json in this repo and modifying it so it corresponds to the command you would need to run in the root of your repository to build the TiddlyWiki. If your tiddlywiki.info file is in the repository root directory, you do not need to modify this.
    • You can verify that everything works so far by running the command npm run build, the wiki HTML file should be saved in the directory output in the root of your repository. This directory can safely be deleted after testing.
  • In to the root of your repository, copy the .github directory from this repository.
  • Add these new files to Git, commit and push to Github.
  • The TiddlyWiki will automatically be built and pushed to your gh-pages branch.
  • If you do not already have Github Pages enabled for your repository, go to the settings page for your repository, choose Pages from the left hand menu. Under "Source" choose the branch "gh-pages" and save.
  • Your wiki will be available at https://{username}.github.io/{reponame}, for example for this repo https://saqimtiaz.github.io/TW5-github-actions-example/
    • Every time you push changes to your repository, an updated TiddlyWiki file will be built and published at this URL