Skip to content

README.md

Latest commit

 

History

History
53 lines (37 loc) · 1.9 KB

README.md

File metadata and controls

53 lines (37 loc) · 1.9 KB
Raw

Maltipoo - DataCite Stylesheets

Sass files for DataCite services, built on top of Bootstrap.

Importing

Import into a JavaScript project using yarn to add directly from the GitHub repo. Specify the version in the command.
example: yarn add https://github.com/datacite/maltipoo#2.2.0

Import TypeScript/JavaScript constants from the package root:
import { RESOURCE_TYPE } from 'maltipoo';

Import the stylesheet into a css file
@import 'maltipoo/stylesheets/doi.min.css';

or a JavaScript file
import 'maltipoo/stylesheets/doi.min.css';

The legacy explicit dist path remains available if needed:
import 'maltipoo/dist/stylesheets/doi.min.css';

Local development

Note: Node 22+ required (pinned in .tool-versions)

Run directly on your OS

Prerequisites

Install and build

  1. git clone https://github.com/datacite/maltipoo.git
  2. cd maltipoo
  3. corepack enable
  4. yarn install
  5. yarn build

The generated JavaScript and TypeScript declaration files are placed in dist, and the generated css files are placed in dist/stylesheets

Issues

Follow along via Github Issues.

Notes on Patches/Pull Requests

  • Fork the project
  • Write tests for your new feature or a test that reproduces a bug
  • Implement your feature or make a bug fix
  • Do not mess with version or history
  • Commit, push and make a pull request. Bonus points for topical branches.

License

maltipoo is released under the MIT License.