Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Deploy documentation website on push to master
  • Loading branch information
pixelastic committed Aug 27, 2018
1 parent 0ef3621 commit 36d1765
Show file tree
Hide file tree
Showing 10 changed files with 15,331 additions and 14 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Expand Up @@ -6,6 +6,4 @@ dist/
npm-debug.log*
yarn-error.log
dist-es5-module/
yarn.lock
tmp
docs/build/
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -57,7 +57,9 @@ them with auto-reload.

- `yarn docs:build` will build the docs website in `./docs/dist`.
- `yarn docs:serve` will do the same, but with live-reload enabled
- `yarn docs:deploy` will deploy the doc website
- `yarn docs:deploy` will deploy the doc website manually

Refer to `./docs/README.md` for more information

## Release

Expand Down
10 changes: 8 additions & 2 deletions docs/README.md
Expand Up @@ -24,12 +24,18 @@ live-reload.

### Deploying the website

You can deploy the website by running `yarn run deploy` in this directory or
`yarn run docs:deploy` at the repository root.
You can deploy the website manually by running `yarn run deploy` in this
directory or `yarn run docs:deploy` at the repository root.

This will build the website and then commit the content of the `./dist` folder
to the `gh-pages` branch and push it to GitHub.

Netlify is configured to listen to all commits on `master` and
run `netlify-master` (see`netlify.toml` in the root). This script will check if
any changes were made in the `./docs` subfolder. If no changes were made, it
will finish, otherwise it will build the website and push it to
`gh-pages`.

## Internals

The documentation generation is not using any existing static websites
Expand Down
10 changes: 5 additions & 5 deletions docs/package.json
Expand Up @@ -9,7 +9,7 @@
"lint:css": "./scripts/lint-css",
"lint:md": "./scripts/lint-md",
"lint:md:fix": "./scripts/lint-md-fix",
"prepush": "./scripts/prepush",
"prepush": "yarn lint",
"serve": "babel-node ./scripts/serve.js"
},
"devDependencies": {
Expand All @@ -34,6 +34,7 @@
"eslint-plugin-prettier": "2.6.2",
"front-matter": "2.3.0",
"fs-extra": "7.0.0",
"gh-pages": "1.2.0",
"glob": "7.1.2",
"husky": "0.14.3",
"inquirer": "6.2.0",
Expand All @@ -43,17 +44,16 @@
"markdown-it-anchor": "5.0.2",
"markdown-it-highlightjs": "3.0.0",
"normalize.css": "8.0.0",
"p-all": "1.0.0",
"p-each-series": "1.0.0",
"p-map": "1.2.0",
"pify": "3.0.0",
"postcss": "6.0.23",
"postcss-clean": "1.1.0",
"postcss-import": "11.1.0",
"postcss-nested": "3.0.0",
"prettier": "1.14.2",
"pug": "2.0.3",
"puppeteer": "1.7.0",
"p-all": "1.0.0",
"p-each-series": "1.0.0",
"p-map": "1.2.0",
"remark-cli": "5.0.0",
"remark-frontmatter": "1.2.1",
"remark-lint-no-trailing-spaces": "2.0.0",
Expand Down
2 changes: 0 additions & 2 deletions docs/scripts/prepush

This file was deleted.

0 comments on commit 36d1765

Please sign in to comment.