Skip to content

mtovt/logos

 
 

Repository files navigation

JetBrains logos and branding materials

official JetBrains project npm (scoped)

Usage guidelines

Please review the Brand Guidelines to get acquainted with our dos and don'ts. If in doubt, please contact [email protected].

Install

npm install @jetbrains/logos

Build

npm run build

Usage in React

import { AppcodeLogo, AppcodeTextLogo } from '@jetbrains/logos/react';

...

<div>
  <AppcodeLogo />
  <AppcodeTextLogo fill="white" />
</div>

Node API

Base directory

index.js allows to obtain package dirname:

const logosPath = require('@jetbrains/logos'); // '/path/to/project/node_modules/jetbrains-logos/'

Files and metas

logos.js allows to obtain the list of resources for a given product as well as HTML markup with all the necessary meta tags:

const utils = require('@jetbrains/logos/logos');

const product = 'hub';
const files = utils.getFiles(/* required */product);

/* Returns an array of absolute paths to files:
[ 
  '/path/to/project/node_modules/jetbrains-logos/hub/favicon.ico',
  '/path/to/project/node_modules/jetbrains-logos/hub/apple-touch-icon.png'
]
*/
const utils = require('@jetbrains/logos/utils');

// An optional filename processor
function processor(filename) {
  return filename;
}

const metas = utils.getMetas(/* optional */processor);

/* Returns the list of meta tags:
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" sizes="16x16 32x32"/>
<link rel="icon" href="icon.svg" type="image/svg+xml"/>
<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png"/>
<meta name="msapplication-TileColor" content="#000000"/>
<meta property="og:title" content="%website_title%" />
<meta property="og:type" content="website" />
<meta property="og:url" content="%website_url%" />
<meta property="og:image" content="og-image-1200x630.png" />
*/

getMetas() will not output OpenGraph tags unless configured. Make sure to call configure() before calling getMetas() and pass it a configuration object with url and title keys:

const utils = require('@jetbrains/logos/logos');

utils.configure({
  url: 'https://teamcity.jetbrains.com',
  title: 'TeamCity CI'
});

utils.getMetas()

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.4%
  • Shell 2.6%