# gatsby-theme-atom-service > Gatsby theme for website that curate Atom packages that provide and consume an Atom service Latest version **1.1.298** (published 2021-08-03) · ISC license · 0 weekly downloads ## Install ```sh npm install gatsby-theme-atom-service pnpm add gatsby-theme-atom-service yarn add gatsby-theme-atom-service bun add gatsby-theme-atom-service ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.298 | | Published | 2021-08-03 | | First published | 2019-10-08 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 17 | | Unpacked size | 58.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | Kepler Sticka-Jones | | Maintainers | keplersj | | Keywords | gatsby, gatsby-theme, atom, atomlinter, atom-linter, atombuild, atom-build, lint | ## Links - npm: https://www.npmjs.com/package/gatsby-theme-atom-service - Repository: https://github.com/keplersj/gatsby-theme-atom-service - Homepage: https://github.com/keplersj/gatsby-theme-atom-service#readme - Issues: https://github.com/keplersj/gatsby-theme-atom-service/issues - npm.io page: https://npm.io/package/gatsby-theme-atom-service ## Dependencies (17) - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4 - [schema-dts](https://npm.io/package/schema-dts.md) ^0.8.2 - [react-helmet](https://npm.io/package/react-helmet.md) ^6.1.0 - [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.168 - [react-schemaorg](https://npm.io/package/react-schemaorg.md) ^1.3.1 - [typeface-roboto](https://npm.io/package/typeface-roboto.md) ^1.1.13 - [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.9.12 - [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.11.2 - [@material-ui/styles](https://npm.io/package/@material-ui/styles.md) ^4.9.14 - [@types/react-helmet](https://npm.io/package/@types/react-helmet.md) ^6.1.0 - [gatsby-plugin-lodash](https://npm.io/package/gatsby-plugin-lodash.md) ^3.10.0 - [gatsby-transformer-yaml](https://npm.io/package/gatsby-transformer-yaml.md) ^2.11.0 - [gatsby-plugin-typescript](https://npm.io/package/gatsby-plugin-typescript.md) ^2.12.1 - [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^2.11.1 - [gatsby-plugin-material-ui](https://npm.io/package/gatsby-plugin-material-ui.md) ^2.1.10 - [gatsby-plugin-react-helmet](https://npm.io/package/gatsby-plugin-react-helmet.md) ^3.10.0 ## Alternatives - [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads - [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads - [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads - [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads - [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads ## Recent versions - 1.1.298 (latest) — 2021-08-03 - 1.1.297 — 2021-06-24 - 1.1.296 — 2021-06-11 - 1.1.295 — 2021-05-27 - 1.1.294 — 2021-05-26 - 1.1.293 — 2021-05-07 - 1.1.292 — 2021-05-06 - 1.1.291 — 2021-05-06 - 1.1.290 — 2021-04-16 - 1.1.289 — 2021-03-29 - 1.1.288 — 2021-03-08 - 1.1.287 — 2021-02-24 - 1.1.286 — 2021-02-24 - 1.1.285 — 2021-02-20 - 1.1.284 — 2021-02-03 - … 325 more at https://npm.io/package/gatsby-theme-atom-service/versions ## README # gatsby-theme-atom-service Gatsby theme for website that curate Atom packages that provide and consume an [Atom service](https://flight-manual.atom.io/behind-atom/sections/interacting-with-other-packages-via-services/). Used to create the [AtomLinter](https://atomlinter.github.io) and [AtomBuild](https://atombuild.github.io) websites. ## Installation In your Gatsby project, run: ```shell npm install gatsby-theme-atom-service ``` ## Usage Add `gatsby-theme-atom-service` to your `gatsby-config.js` ```js module.exports = { plugins: [ "gatsby-theme-atom-service", /// or { resolve: "gatsby-theme-atom-service", options: { // customize any of the options below }, }, ], }; ``` ### Site Metadata In order for the theme to function please define the following in the `siteMetadata` field of your `gatsby-config.js`: ```js module.exports = { siteMetadata: { // Your Project's Title, will also be the title of your website title: "Your Project's Amazing Title!", // The canonical url of your website siteUrl: "https://example.dev", // Description of your project, should be about a sentence in length. description: "A Very Descriptive, Snippet All About Your Project.", // Navigation links. Will be included in the navbar and hamburger menu. nav: [ { name: "A Helpful Link for Navigation", url: "https://helpful.dev/", }, /// ... ], }, }; ``` ### Data YAML is used to curate your list of provider and consumer packages. In your content folder (`./content/` by default) create a `consumers.yml` and `providers.yml` with the following structure: `consumers.yml`: ```yml - title: "" author: "" url: https://atom.io/packages/example code: https://github.com/example/example # ... ``` `providers.yml`: ```yml - type: title: "" modal: "" types: - title: "" modal: "" packages: - title: "" url: https://atom.io/packages/example ``` ### Customization The following options can be passed to the theme in `gatsby-config.js` to customize the site's functionality: | Field Name | Type | Default Value | Description | | ----------------- | --------- | --------------------- | ----------------------------------------------------------------------------------------------------------------- | | `basePath` | `string` | `"/"` | The base path of the theme. Where it will render out your data. Default is the index of your site. | | `assetPath` | `string` | `"./content/assets/"` | The directory in your Gatsby site where site assets (e.g. logos, site images) are stored. | | `contentPath` | `string` | `"./content/data/"` | The folder in your Gatsby site where your data files are stored. | | `renderConsumers` | `boolean` | `true` | Should the theme render content from the consumers data file. Will not check for or requre data file if `false`. | | `renderProviders` | `boolean` | `true` | Should the theme render content from the providers data file. Will not check for or require data file if `false`. | --- _Source: https://npm.io/package/gatsby-theme-atom-service · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._