3.25.0 • Published 2 years ago

@doc-tools/docs v3.25.0

Weekly downloads
135
License
MIT
Repository
github
Last release
2 years ago

english | русский

NPM version

yfm-docs

Yfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full Yandex Flavored Markdown (YFM) support.

Example of displaying a documentation page

Documentation

ydocs.tech

Usage

npm i @doc-tools/docs -g
npm run start -- -i ./input-folder -o ./ouput-folder -v "{\"name\":\"Alice\"}"

Source files

Preparation

You need to add .env file into repo root with data below:

GITHUB_OWNER=
GITHUB_REPO= # docs
GITHUB_TOKEN= # personal access token
GITHUB_BASE_URL= # for ex: https://api.github.com
VCS_CONNECTOR_TYPE= # github

or you can update .yfm file into docs repo

connector:
    type:
    github:
        endpoint:
        token:
        owner:
        repo:

Build from source

cd yfm-docs
npm ci && npm run build

Run TS directly for debug in IDE

npm run start-ts

License

MIT

markdownyandexdocsyfmdocumentationtooltoolsgenerator
@apidevtools/swagger-parser@aws-sdk/client-s3@diplodoc/client@diplodoc/markdown-translation@diplodoc/mermaid-extension@diplodoc/openapi-extension@doc-tools/transform@doc-tools/yfm2xliff@octokit/core@types/glob@types/json-stringify-safe@yandex-cloud/nodejs-sdkajvasyncaws-sdkbem-cn-litechalkdotenvfast-xml-parserglobhighlight.jshtml-escaperhttp-status-codesjs-yamljson-stringify-safemime-typesminimatchnode-html-parsershelljssimple-gitslugifytar-streamthreadsthreads-pluginwalk-syncyargs
@infinitebrahmanuniverse/nolb-_doc@everything-registry/sub-chunk-249
3.24.0

2 years ago

3.25.0

2 years ago

3.22.0

2 years ago

3.19.0

2 years ago

3.23.0

2 years ago

3.20.0

2 years ago

3.20.2

2 years ago

3.20.1

2 years ago

3.20.3

2 years ago

3.17.0

2 years ago

3.17.2

2 years ago

3.17.1

2 years ago

3.21.0

2 years ago

3.18.0

2 years ago

3.16.1

2 years ago

3.16.0

2 years ago

3.16.3

2 years ago

3.16.2

2 years ago

3.14.0

2 years ago

3.15.0

2 years ago

3.13.1

2 years ago

3.2.0

2 years ago

3.12.0

2 years ago

3.1.2

2 years ago

3.1.1

2 years ago

3.1.0

2 years ago

3.13.0

2 years ago

3.9.0

2 years ago

3.8.0

2 years ago

3.10.0

2 years ago

3.8.1

2 years ago

3.11.0

2 years ago

3.7.1

2 years ago

3.7.0

2 years ago

3.11.1

2 years ago

3.5.1

2 years ago

3.5.0

2 years ago

3.4.0

2 years ago

3.3.0

2 years ago

2.11.0

2 years ago

2.4.1

2 years ago

2.4.0

2 years ago

2.10.1

2 years ago

2.10.2

2 years ago

2.3.2

2 years ago

2.10.0

2 years ago

2.3.1

2 years ago

2.3.4

2 years ago

2.3.3

2 years ago

2.3.6

2 years ago

2.3.5

2 years ago

2.3.7

2 years ago

3.0.0

2 years ago

2.9.0

2 years ago

2.8.1

2 years ago

2.8.0

2 years ago

2.7.0

2 years ago

2.7.2

2 years ago

2.7.1

2 years ago

2.8.2

2 years ago

2.8.2-beta.1

2 years ago

2.6.0

2 years ago

2.8.2-beta.0

2 years ago

2.5.0-beta.0

2 years ago

2.5.0

2 years ago

2.4.1-beta.0

2 years ago

2.3.0

2 years ago

2.2.0

2 years ago

2.1.2

2 years ago

2.1.1

2 years ago

2.1.3

2 years ago

2.1.0

2 years ago

2.0.1

2 years ago

2.0.0

2 years ago

1.31.3

3 years ago

1.31.4

2 years ago

1.29.0

3 years ago

1.29.1

3 years ago

1.31.0-beta.0

3 years ago

1.27.1

3 years ago

1.27.0-beta.0

3 years ago

1.27.0-beta.1

3 years ago

1.30.2

3 years ago

1.30.0

3 years ago

1.30.1

3 years ago

1.28.0

3 years ago

1.31.1

3 years ago

1.31.2

3 years ago

1.31.0

3 years ago

1.24.1

3 years ago

1.24.0

3 years ago

1.25.0

3 years ago

1.25.1

3 years ago

1.26.0

3 years ago

1.26.1

3 years ago

1.27.0

3 years ago

1.23.1-beta.0

3 years ago

1.22.4

3 years ago

1.22.5

3 years ago

1.23.2

3 years ago

1.23.0

3 years ago

1.23.1

3 years ago

1.22.0

3 years ago

1.22.3

3 years ago

1.22.1

3 years ago

1.22.2

3 years ago

1.21.3

3 years ago

1.21.1-beta.0

3 years ago

1.21.0

3 years ago

1.21.1

3 years ago

1.21.2

3 years ago

1.20.1

3 years ago

1.20.2

3 years ago

1.20.0-beta.0

3 years ago

1.19.0

3 years ago

1.19.3

3 years ago

1.19.2

3 years ago

1.19.1

3 years ago

1.18.59

3 years ago

1.20.0

3 years ago

1.18.41

3 years ago

1.18.1

3 years ago

1.18.40

3 years ago

1.18.0

3 years ago

1.18.45

3 years ago

1.18.5

3 years ago

1.18.44

3 years ago

1.18.4

3 years ago

1.18.43

3 years ago

1.18.3

3 years ago

1.18.42

3 years ago

1.18.2

3 years ago

1.18.49

3 years ago

1.18.9

3 years ago

1.18.48

3 years ago

1.18.8

3 years ago

1.18.47

3 years ago

1.18.7

3 years ago

1.18.46

3 years ago

1.18.6

3 years ago

1.18.30

3 years ago

1.18.34

3 years ago

1.18.33

3 years ago

1.18.32

3 years ago

1.18.31

3 years ago

1.18.38

3 years ago

1.18.37

3 years ago

1.18.36

3 years ago

1.18.35

3 years ago

1.18.39

3 years ago

1.18.10-beta.0

3 years ago

1.18.52

3 years ago

1.18.51

3 years ago

1.18.50

3 years ago

1.18.56

3 years ago

1.18.55

3 years ago

1.18.54

3 years ago

1.18.53

3 years ago

1.18.58

3 years ago

1.18.57

3 years ago

1.18.23

3 years ago

1.18.22

3 years ago

1.18.21

3 years ago

1.18.20

3 years ago

1.18.27

3 years ago

1.18.26

3 years ago

1.18.25

3 years ago

1.18.24

3 years ago

1.18.29

3 years ago

1.18.28

3 years ago

1.18.12

3 years ago

1.18.11

3 years ago

1.18.10

3 years ago

1.18.16

3 years ago

1.18.15

3 years ago

1.18.14

3 years ago

1.18.13

3 years ago

1.18.19

3 years ago

1.18.18

3 years ago

1.18.17

3 years ago

1.15.1-beta.0

4 years ago

1.15.0

4 years ago

1.15.2

4 years ago

1.15.1

4 years ago

1.16.0

4 years ago

1.15.2-beta.3

4 years ago

1.15.2-beta.2

4 years ago

1.15.2-beta.1

4 years ago

1.15.2-beta.0

4 years ago

1.17.2

3 years ago

1.17.1

3 years ago

1.17.0

4 years ago

1.14.3

4 years ago

1.14.2

4 years ago

1.14.1

4 years ago

1.14.0

4 years ago

1.13.3

4 years ago

1.13.2-beta.0

4 years ago

1.13.2-beta.1

4 years ago

1.13.2-beta.2

4 years ago

1.13.3-beta.0

4 years ago

1.13.2

4 years ago

1.13.1-beta.3

4 years ago

1.13.1-beta.2

4 years ago

1.13.1

4 years ago

1.13.1-beta.0

4 years ago

1.13.1-beta.1

4 years ago

1.13.0-beta.2

4 years ago

1.13.0-beta.1

4 years ago

1.13.0

4 years ago

1.12.3

4 years ago

1.12.2

4 years ago

1.12.1

4 years ago

1.12.0

4 years ago

1.11.10

4 years ago

1.11.8

4 years ago

1.11.9

4 years ago

1.11.7

4 years ago

1.11.6

4 years ago

1.11.5

4 years ago

1.11.4

4 years ago

1.11.3

4 years ago

1.11.0

4 years ago

1.11.2

4 years ago

1.11.1

4 years ago

1.9.0

4 years ago

1.8.8

4 years ago

1.8.7

4 years ago

1.10.1

4 years ago

1.10.0

4 years ago

1.8.2

4 years ago

1.8.1

4 years ago

1.8.6

4 years ago

1.8.5

4 years ago

1.8.4

4 years ago

1.8.3

4 years ago

1.8.0

4 years ago

1.7.3

4 years ago

1.7.4

4 years ago

1.7.2

4 years ago

1.7.1

4 years ago

1.7.0

4 years ago

1.6.5

4 years ago

1.6.4

4 years ago

1.6.3

4 years ago

1.6.2

4 years ago

1.6.1

4 years ago

1.6.0

4 years ago

1.5.1

4 years ago

1.5.0

4 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.3.7

4 years ago

1.3.6

4 years ago

1.3.5

4 years ago

1.3.4

4 years ago

1.3.3

5 years ago

1.3.2

5 years ago

1.3.1

5 years ago

1.3.0

5 years ago

1.2.6

5 years ago

1.2.5

5 years ago

1.2.4

5 years ago

1.2.3

5 years ago

1.2.2

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.8

5 years ago

1.1.7

5 years ago

1.1.6

5 years ago

1.1.5

5 years ago

1.1.4

5 years ago

1.1.3

5 years ago

1.1.2

5 years ago

1.1.1

5 years ago

1.1.0

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.1.0

5 years ago

0.0.5

5 years ago

0.0.1

5 years ago