Documentation for Material Theme UI for Jetbrains

This is the repository for the documentation website for the Material Theme UI plugin.

Please only report issues concerning the documentation.

Contributing

If you want to contribute to the documentation, you can fork this repository and update the docs accordingly:

  1. Fork this repository
  2. Clone your forked repository on your computer
  3. Install Jekyll: bundle install (you need Ruby 2.0+ and Bundler installed)
  4. Install NPM dependencies: npm install (or yarn install)
  5. Run local server: npm run start
  6. Run grunt watch grunt
  7. Open the address http://localhost:8080

Structure

.
├── _data                            - Various lists of items
├── _includes                        - Partials used throughout the docs
├── _layouts                         - Layouts
├── assets                           - Generated folder containing the built assets
├── config                           - Config folder for the Javascript
├── docs                             - Documentation pages
├── img                              - Images
│   ├── accents                             - Accent components
│   ├── arrows                              - Arrow styles
│   ├── brand                               - Logos
│   ├── components                          - Components
│   ├── fileIcons                           - File Icons
│   ├── icons                               - Icons
│   └── screens                             - Screenshots
├── jekyllbuild                      - Generated folder for the Jekyll pages
├── js                               - Generated folder for the Javascript app
├── sass                             - Stylesheets
├── vue                              - The Vue application (not yet built)
├── index.html                       - Main index file
└── _config.yml                      - The Jekyll config file