search

adrianvlupu / C4-Builder

This is a documentation builder. You feed it .md and .puml and it exports a site, pdf, or a markdown with navigation.
https://adrianvlupu.github.io/C4-Builder/
MIT License
562 stars 93 forks source link

feat(web): add the ability to use the original file name #84

Open Jeconias opened 1 year ago

Jeconias commented 1 year ago

Why

This feature allows the use of the docsify-edit-on-github plugin which needs the original file name in the path.

What

Added WEB_FILE_NAME as an option in the configuration.

How to use

If you add webFileName to .c4builder, each .md will be named exactly the same as the defined value. The default value is HOME, see.

This feature ability to use the original file name and remove the default value (HOME).

NOTE NOTE: To maintain compatibility with previous versions of links, add a new option in .c4builder:

{
  "webFileName": "HOME"
}

Example

Without this feature or with the webFileName option equal to "HOME":

https://github.com/adrianvlupu/C4-Builder/assets/32512776/b9bb4a99-f281-4589-8387-a6cbd80c7f2f

With this feature and webFileName not defined or empty:

https://github.com/adrianvlupu/C4-Builder/assets/32512776/83479598-af77-4172-823b-52d608ddb0c0