joshua/dash-website
1
0
Fork 0
mirror of https://github.com/seigler/dash-website synced 2025-07-26 23:06:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

(Feature) Build System: Use npm scripts for the build process (#16)

Browse source 
* (Chore) Editorconfig: Add an editorconfig file so those spaces and tabs dont keep mixing

* (Refactor) Build: use npm scripts to build assets

* (Chore) Build: remove dist files from repo / fix ESLint errors

* (Update) Build: Remove unused tasks / add autoprefixer

* (Chore) Gemfile: remove old dependencies

* (Chore) Package.json: Shrinkwrap & postinstalll

* (Doc) Build: Update instructions for new build system

* (Fix) Build: Wach html files in all folders

* (Fix) Build: exclude _site/ from watch

* (Chore) Build/CI: Update buildscript for node/ruby combined

* (Chore) Travis: Add g++ compiler to environment

* (Chore) Build: fix watched directory

* (Fix) travis: set version to 4.5.0 LTS

* (Fix) travis: remove shrinkwrap

* (Fix) Travis: rvm

* (Fix) Travis: before_install

* (Fix) Travis: ignore dist for html proofer
This commit is contained in:
0xfff 2016-09-17 02:14:13 +02:00 • committed by GitHub
parent 0cd655f34b
commit 2b0331ad48
145 changed files with 408 additions and 416 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -7,16 +7,18 @@ https://jekyllrb.com
### Requirements (mac)
* Ruby: `brew install ruby`
* Ruby Gems: https://rubygems.org/pages/download
* NodeJS: https://nodejs.org/en/
* NodeJS: https://nodejs.org/en/ (Ideally >=4.5.0)
* Python: `brew install python`
* Bundler: `gem install bundler`
### Supporting Gems
Simply run `bundle install` and [bundler](http://bundler.io/) will install all ruby gems/dependencies.
### Dependencies
(If you have nvm, do `nvm install && nvm use` first.)
CI Note: The Gems must also be installed on the CI server.
Simply run `npm install` to install all dependencies. This will also run `bundle install` on *postinstall* to install all ruby gems.
Mac Note: Bundler will try to install the dependency `nokogiri`. If you are using a Mac, and run into issues related to `nokogiri` during `bundle install`, do the following:
**CI Note**: The Gems must also be installed on the CI server.
**Mac Note**: Bundler will try to install the dependency `nokogiri`. If you are using a Mac, and run into issues related to `nokogiri` during `bundle install`, do the following:
`xcode-select --install`
@ -28,14 +30,16 @@ Then run `bundle install`
### Plugins
* `jekyll-multiple-languages-plugin` installed as a gem. Documentation at https://github.com/perrywoodin/jekyll-multiple-languages-plugin. This is a modified fork that adds two new tags for outputting markdown `{% tmd key %}` or `{% translatemd key %}`
## Development
`jekyll serve` Will build to the _site directory whenever a file is changed and serve via 127.0.0.1
(If you still have a `_plugins/jekyll-multiple-languages-plugin` directory in your root folder, you will need to remove it.)
`jekyll build --watch` Will build to the _site directory whenever a file is changed.
## Development
`npm start` or `npm run watch` to build to the _site directory whenever a file is changed and serve via *localhost:3000*
## Production Build
Production builds should be handled by CI.
`npm run build` will build a fully minified, mangled, and compressed build to the _site directory.
Mac
xcode-select --install
gem install nokogiri