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

Convert remote AsciiDoc files to browser guide #62

Open
ggrossetie opened this issue Apr 29, 2022 · 0 comments · May be fixed by #68
Open

Convert remote AsciiDoc files to browser guide #62

ggrossetie opened this issue Apr 29, 2022 · 0 comments · May be fixed by #68
Labels
enhancement New feature or request

Comments

@ggrossetie
Copy link
Collaborator

As requested by @jexp, it would be great to be able to convert any AsciiDoc files to browser guide.
We could add a new route, for instance /browser-guide, that takes a source parameter:

GET https://portal.graphgist.org/browser-guide?source=https://raw.githubusercontent.com/neo4j-contrib/sandbox-code-updater/main/README.adoc

The above route will load the AsciiDoc file from the source parameter (in this case GitHub), convert it to a browser guide and return HTML.

If we want to get fancy, we could support other URL format for GitHub (or other well-know providers), for instance:

?source=https://github.com/neo4j-contrib/sandbox-code-updater/blob/main/README.adoc
?source=github:neo4j-contrib/sandbox-code-updater/main/README.adoc

Or even include the source in the route:

GET https://portal.graphgist.org/browser-guide/github/neo4j-contrib/sandbox-code-updater/main/README.adoc
GET /browser-guide/github/{org}/{repository}/{branch}/{path}

We could then use this URL in the Neo4j browser:

neo4j-desktop://graphapps/neo4j-browser?cmd=play&arg=https://portal.graphgist.org/browser-guide/github/neo4j-contrib/sandbox-code-updater/main/README.adoc
@ggrossetie ggrossetie added the enhancement New feature or request label Apr 29, 2022
ggrossetie added a commit to ggrossetie/graphgist-portal-v3 that referenced this issue May 27, 2022
ggrossetie added a commit to ggrossetie/graphgist-portal-v3 that referenced this issue Jun 13, 2022
ggrossetie added a commit to ggrossetie/graphgist-portal-v3 that referenced this issue Jun 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant