@bbc/morty-docs 4.0.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/build/index.js +567 -0
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ Morty Docs is a library to enable documentation to be generated as a static
|
|
|
6
6
|
website, to allow users to consume the content in an easily accessible format.
|
|
7
7
|
It takes an array of markdown and/or asciidoc files and creates a static website.
|
|
8
8
|
|
|
9
|
-
Morty is specifically aimed at requiring little to no change in the markdown
|
|
9
|
+
Morty is specifically aimed at requiring little to no change in the markdown files.
|
|
10
10
|
|
|
11
11
|
In the BBC we have a large amount of git repositories which often have markdown documentation within them, they don't follow a consistent structure and their content structure can also be wildly different. We wanted a way to publish these with the minimal amount of effort from teams, Morty Docs is what we use to solve this problem.
|
|
12
12
|
|
|
@@ -59,8 +59,8 @@ const { generateTransformInput, transform } = require('@bbc/morty-docs')
|
|
|
59
59
|
|
|
60
60
|
```javascript
|
|
61
61
|
const inputObjs = await generateTransformInput('a/folder/with/markdown-files')
|
|
62
|
-
|
|
63
|
-
const outputObjs = transform(inputObjs,{ contentTitle: 'My Docs', basePath: '/path/my/docs/are/hosted/under' })
|
|
62
|
+
const resolvedPath = path.resolve('path/to/your/docs/folder')
|
|
63
|
+
const outputObjs = transform(inputObjs, { contentTitle: 'My Docs', basePath: '/path/my/docs/are/hosted/under', rootPath: resolvedPath })
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
- `transform()` can be used alone, but if your files are in a local
|