# @baradm100/gatsby-theme-admonation > > TODO: Create a demo Latest version **1.0.1** (published 2020-07-13) · MIT license · 0 weekly downloads ## Install ```sh npm install @baradm100/gatsby-theme-admonation pnpm add @baradm100/gatsby-theme-admonation yarn add @baradm100/gatsby-theme-admonation bun add @baradm100/gatsby-theme-admonation ``` ## 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.0.1 | | Published | 2020-07-13 | | First published | 2020-04-30 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 34 | | Unpacked size | 437.1 KB | | Known vulnerabilities | 0 (+3 in 3 direct dependencies) | | Install scripts | no | | Author | Bar Admoni | | Maintainers | baradm100 | | Keywords | gatsby, gatsby-theme, gatsby-plugin | ## Links - npm: https://www.npmjs.com/package/@baradm100/gatsby-theme-admonation - Issues: https://github.com/baradm100/gatsby-theme-admonation/issues - npm.io page: https://npm.io/package/@baradm100/gatsby-theme-admonation ## Dependencies (34) - [tocbot](https://npm.io/package/tocbot.md) ^4.7.0 - [prismjs](https://npm.io/package/prismjs.md) ^1.17.1 - [slugify](https://npm.io/package/slugify.md) ^1.3.4 - [typescript](https://npm.io/package/typescript.md) ^3.5.2 - [@mdx-js/mdx](https://npm.io/package/@mdx-js/mdx.md) ^1.6.1 - [react-icons](https://npm.io/package/react-icons.md) ^3.7.0 - [react-typed](https://npm.io/package/react-typed.md) ^1.1.2 - [gatsby-image](https://npm.io/package/gatsby-image.md) ^2.4.3 - [react-helmet](https://npm.io/package/react-helmet.md) ^5.2.1 - [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) ^1.6.1 - [styled-normalize](https://npm.io/package/styled-normalize.md) ^8.0.6 - [gatsby-plugin-mdx](https://npm.io/package/gatsby-plugin-mdx.md) ^1.2.6 - [styled-components](https://npm.io/package/styled-components.md) ^4.3.2 - [gatsby-plugin-feed](https://npm.io/package/gatsby-plugin-feed.md) ^2.5.1 - [gatsby-plugin-lunr](https://npm.io/package/gatsby-plugin-lunr.md) ^1.5.1 - [gatsby-plugin-sharp](https://npm.io/package/gatsby-plugin-sharp.md) ^2.6.2 - [gatsby-remark-images](https://npm.io/package/gatsby-remark-images.md) ^3.3.2 - [react-string-replace](https://npm.io/package/react-string-replace.md) ^0.4.4 - [gatsby-plugin-offline](https://npm.io/package/gatsby-plugin-offline.md) ^3.2.1 - [gatsby-plugin-sitemap](https://npm.io/package/gatsby-plugin-sitemap.md) ^2.4.2 - [gatsby-remark-prismjs](https://npm.io/package/gatsby-remark-prismjs.md) ^3.5.1 - [gatsby-plugin-manifest](https://npm.io/package/gatsby-plugin-manifest.md) ^2.4.2 - [gatsby-transformer-yaml](https://npm.io/package/gatsby-transformer-yaml.md) ^2.4.1 - [@types/styled-components](https://npm.io/package/@types/styled-components.md) ^4.1.16 - [gatsby-plugin-robots-txt](https://npm.io/package/gatsby-plugin-robots-txt.md) ^1.5.1 - [gatsby-plugin-typescript](https://npm.io/package/gatsby-plugin-typescript.md) ^2.4.2 - [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^2.3.1 - [gatsby-transformer-sharp](https://npm.io/package/gatsby-transformer-sharp.md) ^2.5.2 - [gatsby-transformer-remark](https://npm.io/package/gatsby-transformer-remark.md) ^2.8.7 - [gatsby-plugin-page-creator](https://npm.io/package/gatsby-plugin-page-creator.md) ^2.3.1 - [gatsby-plugin-react-helmet](https://npm.io/package/gatsby-plugin-react-helmet.md) ^3.3.1 - [gatsby-remark-autolink-headers](https://npm.io/package/gatsby-remark-autolink-headers.md) ^2.3.1 - [gatsby-plugin-styled-components](https://npm.io/package/gatsby-plugin-styled-components.md) ^3.3.1 - [gatsby-plugin-preload-link-crossorigin](https://npm.io/package/gatsby-plugin-preload-link-crossorigin.md) ^1.0.2 ## Recent versions - 1.0.1 (latest) — 2020-07-13 - 1.0.0 — 2020-04-30 ## README # Admonation Gatsby Theme > TODO: Create a demo **admonation** is a Gatsby theme for blogging. ## Features Out-of-the-box: - Fully responsive - Highly optimized (Lighthouse score ~400) - SEO optimized (with open graph, Twitter Card, JSON-LD, RSS, robots.txt and sitemap) - PWA - Syntax highlighting - Search functionality - Multi navigations - Static pages - Fully typed with TypeScript - Tagging - Theming - Customizable See [here](https://nehalem.netlify.com/features) for details! ## Installation > TODO: Create a starter for a quick start! > TODO: Create a demo To use this theme in your Gatsby sites, follow these instructions: 1. Install the theme ```sh npm install --save @baradm100/gatsby-theme-admonation # or yarn add @baradm100/gatsby-theme-admonation ``` 2. Add the theme to your `gatsby-config.js`: ```js module.exports = { plugins: [ { resolve: `@baradm100/gatsby-theme-admonation`, options: { // optional theme options // location to our content contentPath: `content`, // the page manifest manifest: { name: `admonation - A Gatsby theme`, short_name: `admonation`, start_url: `/`, background_color: `#a4cbb8`, theme_color: `#a4cbb8`, display: `minimal-ui`, icon: `${__dirname}/assets/logo.png`, }, // if archive pages should be generated automatically loadDefaultPages: true, // posts shown on the front page postsPerPage: 5, }, }, ], }; ``` Before starting your site make sure that the following requirements are fulfilled: 1. Be sure to have a `content` directory within your Gatsby installation 2. Be sure to have a `tags.yml` file within the `content` directory with _at least_ one tag, e.g. ```yaml - name: Uncategorized color: #000 icon: null featured: false ``` 3. Be sure for your markdown files to include proper frontmatter content, e.g.: ```markdown --- title: 'Post title' path: '/path-to-your-post' tags: ['Theme'] featuredImage: './cover.jpg' excerpt: Descriptive description. created: 2019-07-29 updated: 2019-07-29 --- ``` Finally you can start your site with ```sh gatsby develop ``` ## Documentation TODO ## Author Developed by [nehalist.io](https://nehalist.io) and modified by [Bar Admoni](https://github.com/baradm100). --- _Source: https://npm.io/package/@baradm100/gatsby-theme-admonation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._