@project-r/styleguide
Advanced tools
This is a living style guide. Subject to constant change.
This is a living style guide. Subject to constant change.
It documents the current state and provides implemented React components, published as a npm package.
The logo and fonts are the property of their owners (logo—Project R, GT America—GrilliType and Rubis—Nootype), and may not be reproduced without permission.
The source code is «BSD 3-clause» licensed.
The peer dependencies are: react, prop-types and glamor.
npm install @project-r/styleguide --save
Example button:
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>
)
See components in the menu for a full list and documentation.
glamor needs to be integrated into server rendering. For a simple integration use the 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>
)
}
}
See also:
We want to keep the style guide code simple and will keep the theming options to a minimum. Fork if you want to customize more.
Following environment variables are available for theming:
SG_COLORS={"primary":"Maroon"}
SG_FONT_FAMILIES={"serifRegular":"'Droid Serif', serif"}
SG_FONT_FACES=@import url('https://fonts.googleapis.com/css?family=Droid+Serif')
SG_LOGO_PATH=M0 0 L4 0 L4 1.5 L3 0.5 L2 4 L1 0.5 L0 1.5 Z
SG_LOGO_VIEWBOX=0 0 4 1.5
SG_BRAND_MARK_PATH=M0 4 L1 0 L4 4 Z
SG_BRAND_MARK_VIEWBOX=0 0 4 4
They may be prefixed with REACT_APP_ for CRA compatibility. And will be retrieved from window.ENV, window.__NEXT_DATA__.env or process.env.
This style guide is build with Catalog. You can write documentation in Markdown and React.
You will need Node.js 6.9 or higher.
To start the development server run:
npm install
npm run dev
FAQs
This is a living style guide. Subject to constant change.
The npm package @project-r/styleguide receives a total of 83 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.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.
Security News
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
Security News
Socket CEO Feross Aboukhadijeh discusses open source security challenges, including zero-day attacks and supply chain risks, on the Cyber Security Council podcast.