0.0.2 • Published 5 years ago

@markeroo/themes-list v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

Markeroo Themes

A directory of all the themes for the Markeroo documentation. This project contains two NPM packages:

  • @markeroo/themes - A collection of all the themes, added as a dependency of the bootstrapped project.
  • @markeroo/themes-list - A manifest of supported themes. Used by the CLI, to generate options for the question.

You can check out the manifest. We use Parcel to bundle the assets, in-line with the start scripts.

The project comes with it's set of commands, which help in maintaining a the themes. Just clone this repository to contribute!

Creating a theme (yarn mk)

To create a theme from scratch, simple run the command. You will be asked a set of questions, which help set up the theme. Creating the theme also adds to the manifest. Every theme created, is assigned a unique id.

Deleting a theme (yarn rm <theme-id>)

There's no real reason to ever delete a theme. But in case we ever need to, just running the command will delete all related folders and files. Deleting the theme also removes the theme's entry from the manifest.

Running the development server (yarn start <theme-id>)

To start the development server, simple run the command with the associated theme id.

Contributing

We ❤️ contributions! Any and every contributions are welcome. The project is already setup with linting. Feel free to raise a PR!