Skip to content

Commit 8b5e0b7

Browse files
committed
Update README.md
- Use backticks to mark up file names - fixes Markdown parsing by jekyll which was getting broken by the <version> placeholder - Added backticks in another couple of places for env vars and code snippets
1 parent 2306959 commit 8b5e0b7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Installation
4040
------------
4141

4242
The component has been developed to install on top of an existing Alfresco
43-
4.0, 4.1 or 4.2 installation. The javascript-console-repo-<version>.amp or
44-
javascript-console-share-<version>.amp needs to be installed into the Alfresco
43+
4.0, 4.1 or 4.2 installation. The `javascript-console-repo-<version>.amp` or
44+
`javascript-console-share-<version>.amp` needs to be installed into the Alfresco
4545
Repository / Share webapp using the Alfresco Module Management Tool:
4646

4747
java -jar alfresco-mmt.jar install javascript-console-repo-<version>.amp /path/to/alfresco.war
@@ -60,14 +60,14 @@ project directory:
6060

6161
mvn install
6262

63-
The command builds two JAR files named javascript-console-repo-<version>.jar /
64-
javascript-console-share-<version>.jar and javascript-console-repo-<version>-sources.jar /
65-
javascript-console-share-<version>-sources.jar as well as javascript-console-repo-<version>.amp /
66-
javascript-console-share-<version>.amp in the 'target' directory within your project.
63+
The command builds two JAR files named `javascript-console-repo-<version>.jar` /
64+
`javascript-console-share-<version>.jar` and `javascript-console-repo-<version>-sources.jar` /
65+
`javascript-console-share-<version>-sources.jar` as well as `javascript-console-repo-<version>.amp` /
66+
`javascript-console-share-<version>.amp` in the `target` directory within your project.
6767

6868
If you want to build the module so it can be installed and run in an Alfresco 4.0 / 4.1 server
6969
running on Java 6 you need to have a Java 6 JDK available. Either make sure that your JDK 6 is set
70-
as the default Java environment (PATH / JAVA_HOME environment variable) or run the build with the
70+
as the default Java environment (`PATH` / `JAVA_HOME` environment variable) or run the build with the
7171
following command from the base project directory:
7272

7373
mvn install -P Java6-crossCompile -Djdk6.executable=/path/to/javac
@@ -81,7 +81,7 @@ Using the component
8181
- In the left-hand-side navigation, click *Javascript Console*
8282
- Enter Alfresco repository javascript code in the textarea at the top. Press
8383
the execute button to run the script.
84-
- You can use the special print(..) javascript command to output messages to
84+
- You can use the special `print(..)` javascript command to output messages to
8585
the output window.
8686
- use Ctrl+Space for code completion. Note that only global objects and specific
8787
variables (document, space, variables ending in ...node) are completed.

0 commit comments

Comments
 (0)