layout | title |
---|---|
index |
README |
This is the repository for the documentation website for the Material Theme UI plugin.
Please only report issues concerning the documentation.
If you want to contribute to the documentation, you can fork this repository and update the docs accordingly:
- Fork this repository
- Clone your forked repository on your computer
- Install Jekyll:
bundle install
(you need Ruby 2.0+ and Bundler installed) - Install NPM dependencies:
npm install
(oryarn install
) - Run local server:
npm run start
- Run grunt watch
grunt
- Open the address http://localhost:8080
{% include tree %}
- New pages should be added in the
docs
directory - New images should be added in the
img
directory and in their relevant subfolder - New partials should be added in the
_includes
directory - New pages can be added in the navigation sidebar from the
_data/nav.yml
configuration file. - Screenshots should not be more than 400KB in size