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

[Feature Request]Add Switch of "View on github" #61

Open
chenrylee opened this issue Sep 4, 2020 · 12 comments · May be fixed by #81
Open

[Feature Request]Add Switch of "View on github" #61

chenrylee opened this issue Sep 4, 2020 · 12 comments · May be fixed by #81

Comments

@chenrylee
Copy link

Is it possible to add a switch to control if button View on github is displayed?

/_layouts/default.html line26:

          <a href="{{ site.github.repository_url }}" class="btn btn-github"><span class="icon"></span>View on GitHub</a>

Change to:

{% if site.is_project_page %}
          <a href="{{ site.github.repository_url }}" class="btn btn-github"><span class="icon"></span>View on GitHub</a>
{% endif %}
@Ak-wa
Copy link

Ak-wa commented Sep 6, 2020

Id like that feature too! You can do this yourself btw by adding:

---
---

@import "{{ site.theme }}";

header {
  display: none;
}

to /assets/css/style.scss

That will hide the View on Github button :)

@chenrylee
Copy link
Author

@Ak-wa Yeah, it works, but doesn't exactly meet my demands.
If hiding the header, the site name, site description are hidden as well.
What I exactly want to do is to only hide the View on github button.

TBH, I already changed the default.html.

@davorpa
Copy link

davorpa commented Oct 31, 2020

Hi @chenrylee

Your proupose is interesting.

For backwards compatibility and taking a view on other themes it should be

{% _show_repository_url = site.show_repository_url | default: true %}
{% if _show_repository_url and site.github.is_project_page %}
          <a href="{{ site.github.repository_url }}" class="btn btn-github"><span class="icon"></span>View on GitHub</a>
{% endif %}

Also control other flags to remove the section container when apply.

<section id="downloads">
{% if site.show_downloads %}
<a href="{{ site.github.zip_url }}" class="btn">Download as .zip</a>
<a href="{{ site.github.tar_url }}" class="btn">Download as .tar.gz</a>
{% endif %}
<a href="{{ site.github.repository_url }}" class="btn btn-github"><span class="icon"></span>View on GitHub</a>
</section>

So the entire snippet takes this look more or less:

{% _show_repo_url = site.show_repository_url | default: true %}
{% if site.show_downloads or site.github.is_project_page and _show_repo_url %}
     <section id="downloads">
     {% if site.show_downloads %}
         <a href="{{ site.github.zip_url }}" class="btn">Download as .zip</a>
         <a href="{{ site.github.tar_url }}" class="btn">Download as .tar.gz</a>
      {% endif %}
      {% if site.github.is_project_page and _show_repo_url %}
          <a href="{{ site.github.repository_url }}" class="btn btn-github"><span class="icon"></span>View on GitHub</a>
      {% endif %}
      </section>
{% endif %}

The tasks to resolve in PR should be the following:

  • Apply changes to template.
  • Add the new optional bool parameter show_repository_url: true to _config.yml.

    hacker/_config.yml

    Lines 3 to 4 in 7b7303a

    show_downloads: true
    google_analytics:
  • Update documentation, README.md... to reflect its meaning.

    hacker/README.md

    Lines 32 to 43 in c84111d

    title: [The title of your site]
    description: [A short description of your site's purpose]
    ```
    Additionally, you may choose to set the following optional variables:
    ```yml
    show_downloads: ["true" or "false" to indicate whether to provide a download URL]
    google_analytics: [Your Google Analytics tracking ID]
    ```
    ### Stylesheet

@pil0u
Copy link

pil0u commented Jun 29, 2021

Hey @davorpa, your approach seems great 👍 Any ETA to merge this?

@davorpa
Copy link

davorpa commented Jun 29, 2021

Hey @davorpa, your approach seems great Any ETA to merge this?

Sorry @pil0u I forgot completely this request. I had forked the repo but I'm not be able to install a ruby environment locally to test it. 🤦

💬 It will be a good option use the properties of github pluging (variable site.github.is_project_page) like is used in other themes or with simple site.show_repository_url is enough ⁉️

You can see the result in my previous post

Also related with #45 #42 #26 #25 #16 #14 #3

@pil0u
Copy link

pil0u commented Jun 30, 2021

💬 It will be a good option use the properties of github pluging (variable site.github.is_project_page) like is used in other themes or with simple site.show_repository_url is enough ⁉️

My first feeling is that the more customizable, the better. But as you mentioned all these issues, the real issue here is definitely to be able to get rid the button, so I'd say choose what's the fastest 😄

@davorpa
Copy link

davorpa commented Jul 1, 2021

My first feeling is that the more customizable, the better. But as you mentioned all these issues, the real issue here is definitely to be able to get rid the button, so I'd say choose what's the fastest 😄

One or another, values provided by plugins can always be overriden in _config.yml, so maybe will be redundant to have both.

github:
    is_project_page: false

The authentic flexibility goes by the hands on page. variables, Are provided as meta in any page that extends the layout (e.g. default.html > about-me.html) and therefore can be enhaced to take prevalence from those defined in above file.

{% if  page.show_repository_url | default: site.github.is_project_page %}

B.R.

@pil0u
Copy link

pil0u commented Jul 1, 2021

One or another, values provided by plugins can always be overriden in _config.yml, so maybe will be redundant to have both.

Absolutely, that's what I meant, just pick one.
Your previous comment sounds great 👍

@pil0u
Copy link

pil0u commented Aug 5, 2021

Just noticed this section in the README. That's what I ended up doing by totally removing the line in the layout 👍

davorpa added a commit to davorpa/github-pages-themes-hacker that referenced this issue Aug 8, 2021
Implements pages-themes#61 using github config metadata gem
@davorpa
Copy link

davorpa commented Aug 8, 2021

@pil0u @chenrylee implemented as easy as posible and compatible with other themes

I hope mantainers accepts the pull request #81

@stale
Copy link

stale bot commented Jan 9, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Jan 9, 2022
@davorpa

This comment has been minimized.

@stale stale bot removed the wontfix label Jan 9, 2022
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

Successfully merging a pull request may close this issue.

4 participants