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

gh-pages #3

Open
ghost opened this issue Mar 28, 2021 · 1 comment
Open

gh-pages #3

ghost opened this issue Mar 28, 2021 · 1 comment

Comments

@ghost
Copy link

ghost commented Mar 28, 2021

In looking at the docs folder using duplicate files in scope of crane-search, I wanted to see how we could organize everything to display the useful information without taking up space.

The first question in doing this is how are you hosting the docs page(s)? Is it through the docs folder, are through some other source? I ask this because I had two suggestions:

  • Move docs folder into a gh-pages branch
  • Disperse the docs files throughout the crane-search repository to show where the files are expected to be.

Both of these ideas can be seen kinda like an "embedded template."

P.S.: Let's add that users can link the .js files to <script> tags in HTML :)

@healeycodes
Copy link
Owner

Hi @F1nx!

The first question in doing this is how are you hosting the docs page(s)? Is it through the docs folder, are through some other source?

https://healeycodes.github.io/crane-search/ uses the docs directory.

I'm tempted to use the first suggestion: move docs folder into a gh-pages branch.

One thing I like now is that people see gh-pages.sh and understand how a full example is built.

P.S.: Let's add that users can link the .js files to <script> tags in HTML :)

I'm not sure where you mean but I'm happy to merge this as a PR!

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

1 participant