@project-r/styleguide
Advanced tools
This styleguide is build with [Catalog](https://interactivethings.github.io/catalog/). You can write documention in Markdown and React.
This styleguide is build with Catalog. You can write documention in Markdown and React.
You will need Node.js 6.9 or higher.
To start the development server run:
npm install
npm start
Everything pushed on master is automatically deployed to: styleguide.project-r.construction
User name: Media
Password: GetYourGrooveBack
The peer dependencies are: react and glamor
npm install @project-r/styleguide --save
Then use it in your app:
import {Button} from '@project-r/styleguide'
const Crowdfunding = () => (
<section>
<p>«Es ist Zeit, dass sich die Journalisten unabhängig machen und der Journalismus unabhängig von den Grossverlagen existieren kann. Und ein Modell dafür schafft man nur gemeinsam, oder gar nicht.»</p>
<Button>Mitmachen</Button>
</section>
)
Make sure to include the CSS when server rendering with following pages/_document.js:
import Document, {Head, Main, NextScript} from 'next/document'
import {renderStatic} from 'glamor/server'
export default class MyDocument extends Document {
static async getInitialProps ({renderPage}) {
const page = renderPage()
const styles = renderStatic(() => page.html)
return { ...page, ...styles }
}
render () {
const {css} = this.props
return (
<html>
<Head>
<meta name='viewport' content='width=device-width,initial-scale=1' />
<meta httpEquiv='X-UA-Compatible' content='IE=edge' />
{css ? <style dangerouslySetInnerHTML={{ __html: css }} /> : null}
</Head>
<body>
<Main />
<NextScript />
</body>
</html>
)
}
}
FAQs
This is a living style guide. Subject to constant change.
The npm package @project-r/styleguide receives a total of 793 weekly downloads. As such, @project-r/styleguide popularity was classified as not popular.
We found that @project-r/styleguide demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.