Including directive to require file remotely #234
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Requesting a content string that includes other files that are remote.
With this option, it's possible add directive
<!-- include(/path/file.md) filesystem(host) -->
And indicating to system where the remote file can be located
Ex:
bin/aglio.js -i file.md -s -H http://localhost:3001
Motivation:
Each API has your own markdown files and hosted together with your endpoints services
When a API has a lot of endpoints, the markdown file remain huge, so to simplify the included file, not locally but remotely, this PR was created.
Then a server to provide the documentation of all APIs can render the HTML files including all others markdown files remotely