kopia lustrzana https://github.com/miklobit/TiddlyWiki5
69 wiersze
2.5 KiB
Plaintext
69 wiersze
2.5 KiB
Plaintext
title: Scripts for building tiddlywiki.com
|
|
|
|
These scripts are used to build and release the content for tiddlywiki.com. They are not designed for general purpose use, but you may find techniques that are useful for your own scripts.
|
|
|
|
! Hosting
|
|
|
|
http://tiddlywiki.com is served by [[GitHub Pages|https://pages.github.com]] from the repository https://github.com/Jermolene/jermolene.github.io
|
|
|
|
The scripts live in the repository https://github.com/Jermolene/build.jermolene.github.io
|
|
|
|
! Directory structure
|
|
|
|
These scripts require the following directories to be siblings:
|
|
|
|
* `build.jermolene.github.io` - a local copy of https://github.com/Jermolene/build.jermolene.github.io
|
|
* `jermolene.github.io` - a local copy of the repo https://github.com/Jermolene/jermolene.github.io
|
|
* `TiddlyWiki5` - a local copy of the repo https://github.com/Jermolene/jermolene.github.io
|
|
|
|
The scripts are designed to be executed with the current directory being the `TiddlyWiki5` directory.
|
|
|
|
! Configuration
|
|
|
|
!! package.json
|
|
|
|
The `package.json` in the root of the `build.jermolene.github.io` repository contains a dependency declaration that specifies the latest official released version of TiddlyWiki to be used when building the release targets:
|
|
|
|
```
|
|
|
|
"dependencies": {
|
|
"tiddlywiki": "5.1.2"
|
|
}
|
|
```
|
|
|
|
!! Environment variables
|
|
|
|
Some of the scripts use the following environment variables:
|
|
|
|
* ''TW5_BUILD_MAIN_EDITION'' - the path to the wiki folder to be used as the main edition, generating `index.html` and `encrypted.html`
|
|
* ''TW5_BUILD_OUTPUT'' - the path to the output folder (defaults to `../jermolene.github.io`)
|
|
* ''TW5_BUILD_TIDDLYWIKI'' - the pathname of the `tiddlywiki.js` to be used (defaults to `../build.jermolene.github.io/node_modules/tiddlywiki/tiddlywiki.js`)
|
|
|
|
! Scripts
|
|
|
|
!! `bld.sh`
|
|
|
|
Builds the `tiddlywiki.com` target files. By default, it uses the version of tiddlywiki specified in the `package.json` file. This can be overridden with the ''TW5_BUILD_TIDDLYWIKI'' environment variable. The following command would select the latest prerelease version of tiddlywiki from the `TiddlyWiki5` directory:
|
|
|
|
```
|
|
TW5_BUILD_TIDDLYWIKI=./tiddlywiki.js
|
|
```
|
|
|
|
!! `prerelease-bld.sh`
|
|
|
|
Builds the `tiddlywiki.com/prerelease` target files using the latest TiddlyWiki prerelease code and special ''prerelease'' edition for the content.
|
|
|
|
!! `deploy.sh`
|
|
|
|
Pushes the latest changes to the `jermolene.github.io` directory to GitHub.
|
|
|
|
! Procedures
|
|
|
|
!! Releasing a new version of TiddlyWiki
|
|
|
|
{{Releasing a new version of TiddlyWiki}}
|
|
|
|
!! Releasing new content for TiddlyWiki
|
|
|
|
{{Releasing new content for TiddlyWiki}}
|