diff --git a/doc/browser.md b/doc/browser.md index 9020654359..408ddd77d0 100644 --- a/doc/browser.md +++ b/doc/browser.md @@ -30,7 +30,9 @@ test.test(); You can build a browser version of the compiler by running the following in the 6to5 directory: - $ make build +```sh +$ make build +``` This will output the files `dist/6to5.js` and `dist/6to5.min.js`. @@ -38,7 +40,9 @@ This will output the files `dist/6to5.js` and `dist/6to5.min.js`. To test 6to5 in your browser run: - $ make test-browser +```sh +$ make test-browser +``` And open `test/browser.html` in your browser if it doesn't open automatically. diff --git a/doc/index.md b/doc/index.md index addb20edc9..507cf6435d 100644 --- a/doc/index.md +++ b/doc/index.md @@ -19,12 +19,16 @@ how you want to use it. 6to5 will simply compile your ES6+ script to ES5 if you pass it as an argument to the command-line tool `6to5`: - $ 6to5 script.js +```sh +$ 6to5 script.js +``` If you have a file written using ES6+ and you just want to run it, `6to5-node` has you covered: - $ 6to5-node script.js +```sh +$ 6to5-node script.js +``` And it doesn't end here! To see all the ways you can use 6to5, check out the [Usage](http://6to5.github.io/usage.html) page. diff --git a/doc/optional-runtime.md b/doc/optional-runtime.md index 6dd1ca61de..ee00e657b9 100644 --- a/doc/optional-runtime.md +++ b/doc/optional-runtime.md @@ -18,7 +18,9 @@ Simply use the following option if you're using the [Node API](usage.md#node): or the following flag if you're using the [CLI](usage.md#cli): - $ 6to5 --runtime +```ssh +$ 6to5 --runtime +``` Then just include the runtime before your generated code. @@ -26,7 +28,9 @@ Then just include the runtime before your generated code. You can get the runtime via either: - $ 6to5-runtime +```sh +$ 6to5-runtime +``` or @@ -45,7 +49,9 @@ argument: require("6to5").runtime("myCustomNamespace"); ``` - $ 6to5-runtime myCustomNamespace +```sh +$ 6to5-runtime myCustomNamespace +``` See [Options - runtime](usage.md#options) for documentation on changing the reference in generated code. diff --git a/doc/react.md b/doc/react.md index 302ce6ccba..d73cc12247 100644 --- a/doc/react.md +++ b/doc/react.md @@ -12,5 +12,6 @@ To disable this behaviour add `react` to your blacklist: to5.transform("code", { blacklist: ["react"] }); ``` - - $ 6to5 --blacklist react +```sh +$ 6to5 --blacklist react +``` diff --git a/doc/usage.md b/doc/usage.md index f9e50908f3..4a474def03 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -4,47 +4,67 @@ Compile the file `script.js` and output it to stdout. - $ 6to5 script.js +```sh +$ 6to5 script.js +``` Compile the file `script.js` and output it to `script-compiled.js`. - $ 6to5 script.js --out-file script-compiled.js +```sh +$ 6to5 script.js --out-file script-compiled.js +``` Compile the file `script.js` and output it to `script-compiled.js` and save a source map to `script-compiled.js.map`. - $ 6to5 script.js --source-maps --out-file script-compiled.js +```sh +$ 6to5 script.js --source-maps --out-file script-compiled.js +``` Compile the file `script.js` and output it to `script-compiled.js` with a source map embedded in a comment at the bottom. - $ 6to5 script.js --source-maps-inline --out-file script-compiled.js +```sh +$ 6to5 script.js --source-maps-inline --out-file script-compiled.js +``` Compile the entire `src` directory and output it to the `lib` directory. - $ 6to5 src --out-dir lib +```sh +$ 6to5 src --out-dir lib +``` Compile the entire `src` directory and output it to the one concatenated file. - $ 6to5 src --out-file script-compiled.js +```sh +$ 6to5 src --out-file script-compiled.js +``` Pipe a file in via stdin and output it to `script-compiled.js` - $ 6to5 --out-file script-compiled.js < script.js +```sh +$ 6to5 --out-file script-compiled.js < script.js +``` ### Node Launch a repl. - $ 6to5-node +```sh +$ 6to5-node +``` Evaluate code. - $ 6to5-node -e "class Test { }" +```sh +$ 6to5-node -e "class Test { }" +``` Compile and run `test.js`. - $ 6to5-node test +```sh +$ 6to5-node test +``` ## Node