From 21a791cdcda14e075825ae9b62ac6a5ff413cdb8 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Fri, 17 Oct 2014 16:29:27 +0100 Subject: [PATCH] Docs updates --- .../Developing plugins using Node.js and GitHub.tid | 2 +- .../How to create a translation for TiddlyWiki.tid | 2 +- .../Generating Static Sites with TiddlyWiki.tid | 2 +- ...yWiki for GitHub Pages project documentation.tid | 13 +++---------- 4 files changed, 6 insertions(+), 13 deletions(-) diff --git a/editions/dev/tiddlers/from tw5.com/Developing plugins using Node.js and GitHub.tid b/editions/dev/tiddlers/from tw5.com/Developing plugins using Node.js and GitHub.tid index 97fbeb635..9d271de77 100644 --- a/editions/dev/tiddlers/from tw5.com/Developing plugins using Node.js and GitHub.tid +++ b/editions/dev/tiddlers/from tw5.com/Developing plugins using Node.js and GitHub.tid @@ -87,7 +87,7 @@ For example files see the plugins in the tiddlywiki5 repository i.e. those locat Modify editions/tw5.com/tiddlywiki.info to include a reference to your plugin directory, i.e. find `"plugins": [ ` and add `"yourname/pluginname"`. -From the TW5 directory issue command +From the TW5 directory issue the command ``` ./bin/qbld.sh diff --git a/editions/dev/tiddlers/from tw5.com/How to create a translation for TiddlyWiki.tid b/editions/dev/tiddlers/from tw5.com/How to create a translation for TiddlyWiki.tid index 36a66e84b..c8ad7300a 100644 --- a/editions/dev/tiddlers/from tw5.com/How to create a translation for TiddlyWiki.tid +++ b/editions/dev/tiddlers/from tw5.com/How to create a translation for TiddlyWiki.tid @@ -21,7 +21,7 @@ type: text/vnd.tiddlywiki # Copy the contents of `/core/language/en-GB` into your translation folder # Create a `plugin.info` file (see below) in your translation folder # Edit `/editions/tw5.com/tiddlywiki.info` to add your language to the list -# Run `./bin/qbld.sh` to build TiddlyWiki +# Run `../build.jermolene.github.io/quick-bld.sh` to build TiddlyWiki # Open the TiddlyWiki file at `/MyTranslation/jermolene.github.com/index.html` # You should see your translation listed in the control panel, but the text of the translation will still be in British English # Edit the `.tid` and `.multids` files in your language folder to translate the English text diff --git a/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid b/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid index 32e0b5c86..ca738891e 100644 --- a/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid +++ b/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid @@ -28,7 +28,7 @@ It is also possible to produce a single HTML file that contains static represent For example: alltiddlers.html -The example is built by the following line in `bin/bld.sh`: +The example is built by the following commands: ``` --rendertiddler $:/core/templates/alltiddlers.template.html alltiddlers.html text/plain diff --git a/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid b/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid index 2227b55d1..3dccedebc 100644 --- a/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid +++ b/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid @@ -1,16 +1,16 @@ created: 20130825150100000 modified: 20140912141559011 tags: [[TiddlyWiki on Node.js]] -title: Using TiddlyWiki for GitHub Pages project documentation +title: Using TiddlyWiki for GitHub project documentation type: text/vnd.tiddlywiki -TiddlyWiki5 can be used to produce documentation for GitHub projects. It lets you maintain a single set of documentation as a [[TiddlyWikiFolder|TiddlyWikiFolders]] containing separate tiddler files under source code control, and then use it to produce `readme.md` files for inclusion in project folders, or HTML files for storage in [[GitHub Pages|http://pages.github.com/]]. Both features are demonstrated by TiddlyWiki5 itself. +TiddlyWiki5 can be used to produce documentation for GitHub projects. It lets you maintain a single set of documentation as a [[TiddlyWikiFolder|TiddlyWikiFolders]] containing separate tiddler files under source code control, and then use it to produce `readme.md` files for inclusion in project folders, or HTML files for storage in [[GitHub Pages|http://pages.github.com/]]. Both features are demonstrated by TiddlyWiki5 itself. ! Generating `readme.md` files When displaying the contents of a folder GitHub will look for a `readme.md` file and display it. Note that it will not display full HTML files in this way, just static MarkDown files (this is a security measure). Happily MarkDown permits a safe subset of HTML, and thus to generate a `readme.md` file that is suitable for GitHub it is just necessary for TiddlyWiki5 to generate the content of the `` element of an HTML document, and give it the appropriate filename. -This is done in `bin/bld.sh` by this command: +This is done with this command: ``` --rendertiddler ReadMe ./readme.md text/html @@ -27,10 +27,3 @@ By default, tiddler links will be rendered as `` links to a relative URI cons See the LinkWidget for more details. In this example, tiddler links are rendered as links to the static rendering of tw5.com. - -! Publishing to GitHub Pages - -Publishing to GitHub Pages is very straightforward. In the case of TiddlyWiki5, several different build products are published. - -The `bld.sh` script deposits the build products directly into the local clone of the repo associated with the GitHub Pages account. There is then a manual step to review changes and push them up to github.com. -