Skip to content
This repository has been archived by the owner on Sep 7, 2020. It is now read-only.

Commit

Permalink
Docs: use sh to highlight command since console is not recognized…
Browse files Browse the repository at this point in the history
… and make the page skipped by webpack

Ref

#338
highlightjs/highlight.js#1126
wooorm/lowlight#2
  • Loading branch information
MoOx committed Aug 19, 2016
1 parent f997b8d commit 8fb4d69
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 22 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ boilerplate:
- statinamic (in .css).
To be sure, run the following commands.

```console
```sh
$ npm remove --save-dev statinamic
$ npm install --save-dev phenomic@^0.10.2
$ find . -type f \( -iname \*.css -o -iname \*.js -o -iname \*.json \) -not \( -path './.git/*' -o -path './node_modules/*' \) \
Expand Down Expand Up @@ -602,7 +602,7 @@ boilerplate:

_EDIT: the commands below are not enough, see release **0.10.2**._

```console
```sh
$ npm remove --save-dev statinamic
$ npm install --save-dev phenomic
$ find . -type f \( -iname \*.js -o -iname \*.json \) -not \( -path './.git/*' -o -path './node_modules/*' \) \
Expand All @@ -613,7 +613,7 @@ boilerplate:

If you want to double check what files will be changed, just run

```console
```sh
$ find . -type f \( -iname \*.js -o -iname \*.json \) -not \( -path './.git/*' -o -path './node_modules/*' \)
```

Expand Down
6 changes: 3 additions & 3 deletions boilerplate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

## Install dependencies

```console
```sh
$ npm install
```

## Run development server

```console
```sh
$ npm start
```

## Build for production

```console
```sh
$ npm run build
```
6 changes: 3 additions & 3 deletions docs/content/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: How to contribute to Phenomic

To work on the boilerplate, run the following:

```console
```sh
$ npm run boilerplate-start
```

Expand All @@ -16,7 +16,7 @@ Then you can edit files in the `boilerplate` folder.

To work on the docs, run the following:

```console
```sh
$ npm run docs-start
```

Expand Down Expand Up @@ -44,7 +44,7 @@ Tests will be in ``src/PageContainer/__tests__/*``.

To run tests for the ``PageContainer`` component:

```console
```sh
$ ava src/PageContainer/__tests__/*
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/advanced/good-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Here are some "popular" configs:
If you switch to one of these configurations, you might get some linting errors.
To fix this, simply use the following command:

```console
```sh
$ ./node_modules/.bin/eslint --fix .
```

Expand Down
18 changes: 9 additions & 9 deletions docs/content/docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ magically open itself in your browser!

### macOS / Linux

```console
```sh
$ DIR=your-website-folder && mkdir $DIR && cd $DIR && mkdir node_modules && \
npm i phenomic && ./node_modules/.bin/phenomic setup && npm i && npm start
```

### Windows

```console
```sh
> SET DIR=your-website-folder && mkdir %DIR% && cd %DIR% && mkdir node_modules && ^
npm i phenomic && ./node_modules/.bin/phenomic setup && npm i && npm start
```
Expand All @@ -44,7 +44,7 @@ answer below 😉.

That's an easy step.

```console
```sh
$ DIR=your-website-folder
$ mkdir $DIR && cd $DIR
```
Expand All @@ -59,7 +59,7 @@ _By installing it locally, you ensure that several projects can rely on
different versions of Phenomic.
Anyway, Phenomic will probably not work installed globally._

```console
```sh
$ mkdir node_modules
```

Expand All @@ -69,7 +69,7 @@ finds a ``node_modules`` or a ``package.json``, up to your HOME folder.*

#### Install from npm

```console
```sh
$ npm install phenomic
```

Expand All @@ -82,7 +82,7 @@ $ npm install phenomic

To install from git, you will need to get some deps to transpile sources

```console
```sh
$ npm install babel-cli babel-preset-react babel-preset-es2015 babel-preset-stage-1 babel-plugin-flow-react-proptypes
$ npm install https://github.com/MoOx/phenomic.git
```
Expand All @@ -91,7 +91,7 @@ $ npm install https://github.com/MoOx/phenomic.git

**Notice:** This step will create (and overwrite) any existing ``package.json``.

```console
```sh
$ ./node_modules/.bin/phenomic setup
```

Expand All @@ -109,7 +109,7 @@ the configuration options._

When you are done the setup, it's time to get all dependencies.

```console
```sh
$ npm install
```

Expand All @@ -121,7 +121,7 @@ Now it's time to...

### Start the engine

```console
```sh
$ npm start
```

Expand Down
6 changes: 3 additions & 3 deletions docs/content/docs/usage/gh-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can paste it under ``./scripts/deploy.sh``.

### macOS / Linux

```bash
```sh
#!/usr/bin/env bash
GIT_DEPLOY_REPO=${GIT_DEPLOY_REPO:-$(node -e 'process.stdout.write(require("./package.json").repository)')}

Expand Down Expand Up @@ -75,7 +75,7 @@ In your `package.json`, add the following items under the `scripts` section:

Now run:

```console
```sh
$ npm run deploy
```

Expand Down Expand Up @@ -127,7 +127,7 @@ With only `repo` or `public_repo` scopes.

*Note: replace `{YOU/YOUR_REPO}` and `{YOUR_TOKEN}`.*

```console
```sh
$ npm i -g travis-encrypt
$ travis-encrypt --add --repo {YOU/YOUR_REPO} GITHUB_TOKEN={YOUR_TOKEN}
```
Expand Down

0 comments on commit 8fb4d69

Please sign in to comment.