From 18a358bdf087315044ac222186ba21426c3b725d Mon Sep 17 00:00:00 2001 From: elijah Date: Tue, 19 Aug 2014 14:21:16 -0700 Subject: updated README --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 74e0a29..28b31df 100644 --- a/README.md +++ b/README.md @@ -188,16 +188,21 @@ Amber adds an additional way to make links: [[page-name]] or [[chat/client]] + or + [[label => https://bitmask.net]] By using this double bracket link notation will automatically find the right path for the page with the specified name. Also, it will warn you if the page name is missing and it will ensure that the link is created with the correct -language prefix. In haml, you can get the same effect using +language prefix. In haml, you can get the same effect using ruby code `link 'label' => 'page'` -The standard textile method of linking does not work well with non-latin -languages, so it is recommended that you always use the amber method of -forming links. +The standard textile and markdown methods of linking do not work well with +non-latin languages or right-to-left script, so it is recommended that you +always use the amber method of forming links. + +The arrows `->` and `=>` can be used interchangeably. For right-to-left script, +the arrow goes the opposite direction (`<-` or `<=`). Setting page properties -------------------------------------------- @@ -236,8 +241,6 @@ Available properties: * `@this.alias` -- An alternate url path (or paths if the value is an array) where this page should be available. -Note: for haml files, properties need to be prefixed with '-'. - Tracking pages that need translating -------------------------------------------- -- cgit v1.2.3