https://github.com/jetbrains/logos
https://github.com/jetbrains/logos
branding jetbrains-ui logos svg
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jetbrains/logos
- Owner: JetBrains
- License: other
- Created: 2017-07-31T11:55:58.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T09:12:23.000Z (over 1 year ago)
- Last Synced: 2025-04-22T13:09:26.186Z (about 1 year ago)
- Topics: branding, jetbrains-ui, logos, svg
- Language: JavaScript
- Size: 17.8 MB
- Stars: 30
- Watchers: 31
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# JetBrains logos and branding materials
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[](https://www.npmjs.com/package/@jetbrains/logos)
## Usage guidelines
Please review the [Brand Guidelines](https://www.jetbrains.com/company/brand) to get acquainted with our dos and don'ts.
If in doubt, please contact [marketing@jetbrains.com](mailto:marketing@jetbrains.com).
## Install
```
npm install @jetbrains/logos
```
## Build
```
npm run build
```
## Usage in React
```js
import { AppcodeLogo, AppcodeTextLogo } from '@jetbrains/logos/react';
...
```
## Node API
### Base directory
`index.js` allows to obtain package dirname:
```js
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:
```js
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'
]
*/
```
```js
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:
*/
```
`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:
```js
const utils = require('@jetbrains/logos/logos');
utils.configure({
url: 'https://teamcity.jetbrains.com',
title: 'TeamCity CI'
});
utils.getMetas()
```