Merge pull request #6 from advanced-rest-client:develop

develop

.github/workflows/deployment.yml

@@ -0,0 +1,49 @@
+name: Tests and publishing
+env:
+  FORCE_COLOR: 1
+on:
+  push:
+    branches:
+      - master
+      - main
+jobs:
+  tag:
+    name: "Publishing release"
+    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+      - uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm install
+      - name: Read version from package.json
+        uses: culshaw/read-package-node-version-actions@v1
+        id: package-node-version
+      - name: Changelog
+        uses: scottbrenner/generate-changelog-action@master
+        id: Changelog
+      - name: Github Release
+        id: create_release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ steps.package-node-version.outputs.version }}
+          body: |
+            ${{ steps.Changelog.outputs.changelog }}
+          draft: false
+          prerelease: false
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,17 +1,14 @@
-[![Published on NPM](https://img.shields.io/npm/v/@advanced-rest-client/markdown-styles.svg)](https://www.npmjs.com/package/@advanced-rest-client/markdown-styles)
-
 # Markdown styles set for API components
 
 The styles are applied to the element with `[slot="markdown-html"]` attribute.
 
-### API components
-
-This components is a part of [API components ecosystem](https://elements.advancedrestclient.com/)
+[![Published on NPM](https://img.shields.io/npm/v/@advanced-rest-client/markdown-styles.svg)](https://www.npmjs.com/package/@advanced-rest-client/markdown-styles)
 
 ## Usage
 
 ### Installation
-```
+
+```sh
 npm install --save @advanced-rest-client/markdown-styles
 ```
 
@@ -23,11 +20,14 @@ import markdownStyles from '@advanced-rest-client/markdown-styles/markdown-style
 
 class MarkdownImpl extends LitElement {
   static get styles() {
-    return css`
-    :host {
-      ...
-    }
-    ${markdownStyles}
+    return [
+      css`
+        :host {
+          ...
+        }`
+      ,
+      markdownStyles
+    ],
   }
 
   render() {
@@ -41,6 +41,8 @@ class MarkdownImpl extends LitElement {
 
 ### In a Polymer 3 element
 
+Note, Polymer styles are deprecated and will be removed.
+
 ```js
 import {PolymerElement, html} from '@polymer/polymer';
 import '@advanced-rest-client/markdown-styles/markdown-styles-polymer.js';
@@ -60,10 +62,10 @@ customElements.define('sample-element', SampleElement);
 
 Note, the element does not include Polymer library.
 
-### Installation
+## Development
 
 ```sh
 git clone https://github.com/advanced-rest-client/markdown-styles
-markdown-styles
+cd markdown-styles
 npm install
 ```

markdown-styles.js

@@ -323,11 +323,12 @@ export default css`[slot="markdown-html"] {
 [slot="markdown-html"] pre,
 pre[slot="markdown-html"] {
   background: var(--code-background-color, #f5f2f0);
+  border: var(--inline-code-border, inherit);
 }
 
 /* Inline code */
 [slot="markdown-html"] :not(pre) > code {
-  padding: .1em;
+  padding: var(--inline-code-padding, .1em);
   border-radius: .3em;
   white-space: normal;
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@advanced-rest-client/markdown-styles",
   "description": "Element that displays response documentation for RAML",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "license": "Apache-2.0",
   "main": "markdown-styles.js",
   "module": "markdown-styles.js",