3.25.0 • Published 8 months ago

@doc-tools/docs v3.25.0

Weekly downloads
135
License
MIT
Repository
github
Last release
8 months 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

8 months ago

3.25.0

8 months ago

3.22.0

8 months ago

3.19.0

9 months ago

3.23.0

8 months ago

3.20.0

9 months ago

3.20.2

9 months ago

3.20.1

9 months ago

3.20.3

9 months ago

3.17.0

10 months ago

3.17.2

10 months ago

3.17.1

10 months ago

3.21.0

9 months ago

3.18.0

10 months ago

3.16.1

10 months ago

3.16.0

10 months ago

3.16.3

10 months ago

3.16.2

10 months ago

3.14.0

10 months ago

3.15.0

10 months ago

3.13.1

10 months ago

3.2.0

11 months ago

3.12.0

10 months ago

3.1.2

11 months ago

3.1.1

11 months ago

3.1.0

12 months ago

3.13.0

10 months ago

3.9.0

10 months ago

3.8.0

11 months ago

3.10.0

10 months ago

3.8.1

11 months ago

3.11.0

10 months ago

3.7.1

11 months ago

3.7.0

11 months ago

3.11.1

10 months ago

3.5.1

11 months ago

3.5.0

11 months ago

3.4.0

11 months ago

3.3.0

11 months ago

2.11.0

1 year ago

2.4.1

1 year ago

2.4.0

1 year ago

2.10.1

1 year ago

2.10.2

1 year ago

2.3.2

1 year ago

2.10.0

1 year ago

2.3.1

1 year ago

2.3.4

1 year ago

2.3.3

1 year ago

2.3.6

1 year ago

2.3.5

1 year ago

2.3.7

1 year ago

3.0.0

12 months ago

2.9.0

1 year ago

2.8.1

1 year ago

2.8.0

1 year ago

2.7.0

1 year ago

2.7.2

1 year ago

2.7.1

1 year ago

2.8.2

1 year ago

2.8.2-beta.1

1 year ago

2.6.0

1 year ago

2.8.2-beta.0

1 year ago

2.5.0-beta.0

1 year ago

2.5.0

1 year ago

2.4.1-beta.0

1 year ago

2.3.0

1 year ago

2.2.0

1 year ago

2.1.2

1 year ago

2.1.1

1 year ago

2.1.3

1 year ago

2.1.0

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

1.31.3

1 year ago

1.31.4

1 year ago

1.29.0

2 years ago

1.29.1

2 years ago

1.31.0-beta.0

1 year ago

1.27.1

2 years ago

1.27.0-beta.0

2 years ago

1.27.0-beta.1

2 years ago

1.30.2

1 year ago

1.30.0

1 year ago

1.30.1

1 year ago

1.28.0

2 years ago

1.31.1

1 year ago

1.31.2

1 year ago

1.31.0

1 year ago

1.24.1

2 years ago

1.24.0

2 years ago

1.25.0

2 years ago

1.25.1

2 years ago

1.26.0

2 years ago

1.26.1

2 years ago

1.27.0

2 years ago

1.23.1-beta.0

2 years ago

1.22.4

2 years ago

1.22.5

2 years ago

1.23.2

2 years ago

1.23.0

2 years ago

1.23.1

2 years ago

1.22.0

2 years ago

1.22.3

2 years ago

1.22.1

2 years ago

1.22.2

2 years ago

1.21.3

2 years ago

1.21.1-beta.0

2 years ago

1.21.0

2 years ago

1.21.1

2 years ago

1.21.2

2 years ago

1.20.1

2 years ago

1.20.2

2 years ago

1.20.0-beta.0

2 years ago

1.19.0

2 years ago

1.19.3

2 years ago

1.19.2

2 years ago

1.19.1

2 years ago

1.18.59

2 years ago

1.20.0

2 years ago

1.18.41

2 years ago

1.18.1

2 years ago

1.18.40

2 years ago

1.18.0

2 years ago

1.18.45

2 years ago

1.18.5

2 years ago

1.18.44

2 years ago

1.18.4

2 years ago

1.18.43

2 years ago

1.18.3

2 years ago

1.18.42

2 years ago

1.18.2

2 years ago

1.18.49

2 years ago

1.18.9

2 years ago

1.18.48

2 years ago

1.18.8

2 years ago

1.18.47

2 years ago

1.18.7

2 years ago

1.18.46

2 years ago

1.18.6

2 years ago

1.18.30

2 years ago

1.18.34

2 years ago

1.18.33

2 years ago

1.18.32

2 years ago

1.18.31

2 years ago

1.18.38

2 years ago

1.18.37

2 years ago

1.18.36

2 years ago

1.18.35

2 years ago

1.18.39

2 years ago

1.18.10-beta.0

2 years ago

1.18.52

2 years ago

1.18.51

2 years ago

1.18.50

2 years ago

1.18.56

2 years ago

1.18.55

2 years ago

1.18.54

2 years ago

1.18.53

2 years ago

1.18.58

2 years ago

1.18.57

2 years ago

1.18.23

2 years ago

1.18.22

2 years ago

1.18.21

2 years ago

1.18.20

2 years ago

1.18.27

2 years ago

1.18.26

2 years ago

1.18.25

2 years ago

1.18.24

2 years ago

1.18.29

2 years ago

1.18.28

2 years ago

1.18.12

2 years ago

1.18.11

2 years ago

1.18.10

2 years ago

1.18.16

2 years ago

1.18.15

2 years ago

1.18.14

2 years ago

1.18.13

2 years ago

1.18.19

2 years ago

1.18.18

2 years ago

1.18.17

2 years ago

1.15.1-beta.0

2 years ago

1.15.0

2 years ago

1.15.2

2 years ago

1.15.1

2 years ago

1.16.0

2 years ago

1.15.2-beta.3

2 years ago

1.15.2-beta.2

2 years ago

1.15.2-beta.1

2 years ago

1.15.2-beta.0

2 years ago

1.17.2

2 years ago

1.17.1

2 years ago

1.17.0

2 years ago

1.14.3

3 years ago

1.14.2

3 years ago

1.14.1

3 years ago

1.14.0

3 years ago

1.13.3

3 years ago

1.13.2-beta.0

3 years ago

1.13.2-beta.1

3 years ago

1.13.2-beta.2

3 years ago

1.13.3-beta.0

3 years ago

1.13.2

3 years ago

1.13.1-beta.3

3 years ago

1.13.1-beta.2

3 years ago

1.13.1

3 years ago

1.13.1-beta.0

3 years ago

1.13.1-beta.1

3 years ago

1.13.0-beta.2

3 years ago

1.13.0-beta.1

3 years ago

1.13.0

3 years ago

1.12.3

3 years ago

1.12.2

3 years ago

1.12.1

3 years ago

1.12.0

3 years ago

1.11.10

3 years ago

1.11.8

3 years ago

1.11.9

3 years ago

1.11.7

3 years ago

1.11.6

3 years ago

1.11.5

3 years ago

1.11.4

3 years ago

1.11.3

3 years ago

1.11.0

3 years ago

1.11.2

3 years ago

1.11.1

3 years ago

1.9.0

3 years ago

1.8.8

3 years ago

1.8.7

3 years ago

1.10.1

3 years ago

1.10.0

3 years ago

1.8.2

3 years ago

1.8.1

3 years ago

1.8.6

3 years ago

1.8.5

3 years ago

1.8.4

3 years ago

1.8.3

3 years ago

1.8.0

3 years ago

1.7.3

3 years ago

1.7.4

3 years ago

1.7.2

3 years ago

1.7.1

3 years ago

1.7.0

3 years ago

1.6.5

3 years ago

1.6.4

3 years ago

1.6.3

3 years ago

1.6.2

3 years ago

1.6.1

3 years ago

1.6.0

3 years ago

1.5.1

3 years ago

1.5.0

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.3.7

3 years ago

1.3.6

3 years ago

1.3.5

3 years ago

1.3.4

3 years ago

1.3.3

3 years ago

1.3.2

3 years ago

1.3.1

3 years ago

1.3.0

4 years ago

1.2.6

4 years ago

1.2.5

4 years ago

1.2.4

4 years ago

1.2.3

4 years ago

1.2.2

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.1.8

4 years ago

1.1.7

4 years ago

1.1.6

4 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.3

4 years ago

1.1.2

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

0.1.0

4 years ago

0.0.5

4 years ago

0.0.1

4 years ago