Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docs #1

Open
etc-tiago opened this issue Aug 27, 2020 · 4 comments
Open

Add Docs #1

etc-tiago opened this issue Aug 27, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@etc-tiago
Copy link
Contributor

  • How install
  • How use
    • In html
    • In React
    • In Next.js
    • In Gatsby
    • In Angular
    • In Vue
    • In Nuxt.js
  • Why use
  • How collaborate with atomic css with reutilizable classes names
@etc-tiago etc-tiago added the documentation Improvements or additions to documentation label Aug 27, 2020
@shannonxtreme
Copy link

Hey, need any help with documenting this?

@etc-tiago
Copy link
Contributor Author

etc-tiago commented Aug 27, 2020

Hey @shannonxtreme, help is always welcome! So far my focus has been on developing and correcting the logic of css atomicity.

If you want to help, there are two reference files in the core package:

  • packages/core/src/index.getRules.test.ts
  • packages/core/src/index.sheet.test.ts

If you are testing, just install the @atmc/css package and use as

const {css} = require('@atmc/css');
//...
<div className={css({color: 'blue'})}>Text</div>

The package @atmc/css is pre-configured and ready to use.

@shannonxtreme
Copy link

Not sure how to install the package unfortunately. Could you walk me through it? I'm using Ubuntu 20.04! Also, would you prefer the documentation in markdown or another format?

@etc-tiago
Copy link
Contributor Author

At the current stage, you can run the code using nodejs/npm. You can start here https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants