generate a readme.md from external documentaion

[slang123]

Hi,
Is it possible to generate a readme.md from the external documention and place the readme.md at the root of the project

[jwikman]

Is it possible to generate a readme.md from the external documention and place the readme.md at the root of the project

It should definitely be possible.

But can you please elaborate on what you want that readme.md to include? An example would be great to understand what information you want.

[jwikman]

Hi @slang123
I just released something like this in the latest pre-release version.

Please install pre-release 1.17.202140831 and activate the NAB.documentation.output.indexFile setting.

When NAB.documentation.output.indexFile is true, an index.md will be created when creating the external documentation. (note that the setting NAB.CreateTocFilesForDocs must be enabled as well for this to work, since I am using the TOC.yml files to generate this index file).

There is also a setting, NAB.documentation.output.indexFileDepth, that specifies how many levels that should be included in the index file. Default is 2, but I think there are up to 5 levels that can be created.

Let me know what you think about it.

[slang123]

Hi @jwikman
This looks great. Now all I need is a filePath/name setting. Then I could call the file readme.md and place it in the root folder. like the NAB:Tooltip Docs File Path. I Tried to copy it, but then ofcourse the paths in the index file dont match :)

[jwikman]

@slang123 I think that would be possible to add, but I believe that the settings has to be a relative path, like "../readme.md" to place it in the parent directory of the other documentation. In that way I could handle the links to point right.

[jwikman]

@slang123 So, I added a new setting NAB.documentation.output.indexFilePath. Use that to configure your relative path to your index file. If I understood you correctly, you should probably set this to "../readme.md".

It is released in v1.17.202152327. I just published that, so it should be available any minute now.

[slang123]

@jwikman
This is perfect and exactly what I was looking for.
Thank you