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

New Features Discussion: Embed docs as iframe (and a few others) #39

Open
jdeveloperw opened this issue Mar 24, 2022 · 3 comments
Open

Comments

@jdeveloperw
Copy link

First off, thank you so much for creating this project! Much like you, I was dismayed to find little support for self-hosting docs. I was happy to find your project, as it is really close to what I need.

I've been working on some modifications to this project, which have begun to diverge:

  • Add support for URL prefix / application root - for example, everything is hosted under /docs/
  • Add upload page that wraps /hmfd
  • Add nav bar with link to home and upload pages
  • Embed actual uploaded docs as an iframe, so that we have a navbar and can always get back home

Are these updates in line with your vision of the project? If so, I'll submit a PR. If not, I'll create a "fork" of the project and change the name. If I do fork, how would you like your project to be credited?

@jdeveloperw jdeveloperw changed the title New Feature Discussion: Embed docs as iframe New Features Discussion: Embed docs as iframe (and a few others) Mar 24, 2022
@rgalanakis
Copy link
Owner

I haven't had to use this for a while so don't have a strong long-term vision for it. If you can do backwards-compatible changes, great. If not, that's fine too, and we can release a 2.0, or I can add your fork to the README if you're willing to maintain it. I think most people use this as an application rather than a library (and quite a few have their own forks), so being an upstream fork isn't much benefit- but apparently this project is mildly popular so if you want to work off that, than promoting your own fork, that can work.
So, whatever you think, you're the one doing the work- if it's a good project and maintained well I'm happy to help where I can in terms of promotion.

@jdeveloperw
Copy link
Author

Thanks, @rgalanakis! As I continue to iterate, I'm still deciding as to whether it makes sense to have this be a new version of hostthedocs or fork it as a new project. I appreciate the offer of promoting my work. I'll post on this thread when my changes are complete.

@Semiotikal
Copy link

@jdeveloperw for whatever its worth, I'd be interested in your added modifications! Still learning how to use this in general but your features sound fantastic additions
:)

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

No branches or pull requests

3 participants