Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Including directive to require file remotely #234

Closed
wants to merge 1 commit into from

Conversation

dadario
Copy link

@dadario dadario commented Feb 10, 2016

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

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
@danielgtaylor
Copy link
Owner

@dadario thanks, this is really great work! Due to the official API Blueprint moving toward Hercule I'd like to hold off on any new features to the Aglio-specific inclusion functionality.

My suggestion would be to add this sort of feature to Hercule so that all the various API Blueprint tools can use it. Right now one of the problems a lot of users experience with Aglio is that the include directive doesn't work when they take their API Blueprint file over to e.g. Dredd for automated testing. Hercule should help to fix this as it will be the standard all the tools use!

@danielgtaylor
Copy link
Owner

@dadario actually it looks like this will be solved by #241, which will be merged soon. I'm closing this in favor of that, but do please reopen if you feel I've missed something!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants