Skip to content

Numigi/numigi-docs-theme

Repository files navigation

Numigi DOCS theme

This repository contains a GROWI plugin for the Numigi custom UI theme.

Getting Started

  1. Clone this repository
  2. Create a new branch
git checkout -b MY_BRANCH_NAME
  1. Install the project dependencies
npm install
  1. Test your build
npm run build
  1. Commit your changes
  2. Open a pull request

Commits & Releases

Committing

Commits format is enforced using Commitizen and follows the AngularJS commit standard.

This allows for easier automated releases

Automated Releases

Releases and packages version changes are all automated using semantic-release.

Its configuration is available in the .releaserc.json file.

Make sure that the TOKEN action secret is configured and has access to this repository.

Ressources

This plugin design is based off GROWI's Vivid Internet plugin example.

Structure

The structure is divided following a Sass atomic structure. This helps creating and maintaining components rules in many files, from the least complex element to a complete page.

alt text

Many articles and blogs refer to this type of architecture convention;