Skip to content
This repository has been archived by the owner on Oct 23, 2023. It is now read-only.

Latest commit

 

History

History
60 lines (37 loc) · 1.99 KB

README.md

File metadata and controls

60 lines (37 loc) · 1.99 KB

This repo hosts the documentation for the Swatch color library

This repository contains only the docs of the @fwrlines/swatch color library. If you are looking for the library (and not the docs), you can go :

  • here if you are looking for the library source code of @fwrlines/swatch
  • here if you are looking for the docs of @fwrlines/swatch

Maintainance information

The library @fwrlines/swatch and the docs (here) are actively maintained. (November 2020) They will continue to be maintained in the foreseeable future.

The main objective of the swatch library is reliability and stability, more than the development of new features.

Contributions

If you wish to raise an issue or contact the team, we welcome your messages in the following way

Your contributions are welcome.

Website

This website is built using Docusaurus 2, a modern static website generator. It is hosted on Vercel and can be seen here

Installation

$ npm i

Local Development

$ npm run start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Credits

These docs are made by Ali M. and Adrian V. in 2020