open-index/open-npm huggingface dataset:
npm package: @frontender-magazine/article-builder
Description: Build article from repo
Author: Anton Nremtsev
Latest version: 1.4.0

# Transform repo to article

## Environment variables

    MONGODB_HOST=localhost
    MONGODB_PORT=27017
    MONGODB_NAME=fm
    COLLECTION_NAME=article
    ARTICLE_SERVICE=article.frontender.info
    PROTOCOL=http://
    ORG_NAME=FrontenderMagazine
    GITHUB_TOKEN=

# Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [ArticleBuilder](#articlebuilder)
    -   [Parameters](#parameters)
    -   [Examples](#examples)

## ArticleBuilder

Transform repo to html article

### Parameters

-   `reponame` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** repository name
-   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path where article will be created

### Examples

```javascript
(async function(){
   await builder(
     'the-art-of-html-semantics-pt1',
     '../websites/articles/'
   );
 })();
```
npm package: @frontender-magazine/builder
Description: build an article from url
Author: Anton Nremtsev
Latest version: 1.4.15

# Builder
Этот билдер создает из url статьи репозиторий на гитхабе и выполняет все сопутствующие действия.

# Environment variables

## createCards, createRepo, initGithub, uploadToRepo
* GITHUB_TOKEN

## codepenTransform and codepenTransformIFrame
* GITHUB_LOGIN
* GITHUB_PASSW

## detectLanguage
* DETECTLANGUAGE_KEY

## getTags
* AWSAccessKeyId
* AWSSecretKey


# You may ignore build stages and specific plugins

```javascript
this.skip = {
      plugins: [
        {
          name: 'TMPDir', // plugin TMPDir
          stages: 'after', // will be ignored on after stage
        },
        { name: 'uploadToRepo' }, // plugin uploadToRepo will be ignored on all stages
      ],
      stages: [
        'github:before', // stage will be ignored
      ],
    };
```

# You may create plugins

```javascript
// File: /source/plugins/pluginName/pluginName.js
module.exports = deepmerge(pluginBase, {
  meta: {
    name: 'PluginName', // plugin name, required
    dependency: ['PluginDep', 'PluginDep:StageName'], // plugin dependency, optional
    domain: 'https://smashingmagazine.com' // plugin valid only for specific domain, optional
  },
  StageName: (unmodified) => {return modified;}, // methods for stage 'StageName'
  [['StageName:before']]: (unmodified) => {return modified;}, // methods for stage 'StageName:before'
});
```
npm package: @frontender-magazine/fm-user
Description: SDK for user service api
Author: Anton Nemtsev
Latest version: 1.0.9

# Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## DummyService

**Extends TMMicroServiceAPI**

-   **See: <https://jsonplaceholder.typicode.com/>**

Dummy Micro Service API that you may adopt for your needs

**Parameters**

-   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** service url
-   `token` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** user access tocken if available (optional, default `null`)

### Array

Posts list object

Type: PostList

**Properties**

-   `null-null` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;Post>** array of posts

### Post

Post object

Type: Post

**Properties**

-   `id` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** post id
-   `title` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** post title
-   `body` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** post body

### messages

Object with class service messages

### get

Get posts list

**Examples**

_Read posts list_

```javascript
(async () => {
  const Dummy = new DummyService('https://jsonplaceholder.typicode.com/');
  const list = await Dummy.get();
})();
```

Returns **PostList** array of posts

### post

Create post

**Parameters**

-   `title` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** post title
-   `body` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** post body

**Examples**

_Create post_

```javascript
(async () => {
  const Dummy = new DummyService('https://jsonplaceholder.typicode.com/');
  const details = await Dummy.post('My Title', 'My Text');
})();
```

Returns **Post** created post

### details

Read specific post

**Parameters**

-   `id` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** post id

**Examples**

_Get post_

```javascript
(async () => {
  const Dummy = new DummyService('https://jsonplaceholder.typicode.com/');
  const details = await Dummy.details(2);
})();
```

Returns **Post** post content