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.

Sign up for GitHub

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

Jump to bottom

Can you add a yml variable to toggle search? #10

Closed
cudmore opened this issue Apr 4, 2016 · 1 comment · Fixed by #98
Closed

Can you add a yml variable to toggle search? #10

cudmore opened this issue Apr 4, 2016 · 1 comment · Fixed by #98

Comments

@cudmore
Copy link

cudmore commented Apr 4, 2016

Hi there,

Can you add a yml variable like 'include_search' so we can toggle the search in the navigation bar on and off? I've added this to my local copy of Cinder with the following {% include_search %}/{% endif %} in nav.html

            {% if include_search %}
                <li>
                    <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
                        <i class="fa fa-search"></i> Search
                    </a>
                </li>
            {% endif %}

Thanks for the wonderful theme. I normally tweak Jekyll for larger sites and wanted to use mkdocs/cinder for a very small (3-4 page) site. Cinder is great out of the box. Thanks.
@chrissimpkins
Copy link
Owner

Do you want to contribute this as a pull request?

@lewiseason lewiseason mentioned this issue Oct 24, 2020
Closed
lewiseason added a commit to lewiseason/cinder that referenced this issue Oct 24, 2020
@lewiseason
Add feature toggles to disable parts of the theme without overriding …
206a3b7 
…its files

Several toggles which are settable in `mkdocs.yml` to allow for turning
theme features off. Often you (or at least I!) want to turn things off,
but have no need to make further customizations.

The ones I came up with are:

* `disable_nav_previous_next`: Turn off Previous/Next navigation links in the navbar
* `disable_nav_search`: Turn off Search in the navbar
* `disable_nav_site_name`: Turn off the site_name link in the navbar
* `disable_footer`: Turn off the footer entirely
* `disable_footer_except_revision`: Turn off the default footer message, but display the page revision date if it's available

Closes chrissimpkins#10
Closes chrissimpkins#97
lewiseason added a commit to lewiseason/cinder that referenced this issue Oct 24, 2020
@lewiseason
Add feature toggles to disable parts of the theme without overriding …
f871169 
…its files

Several toggles which are settable in `mkdocs.yml` to allow for turning
theme features off. Often you (or at least I!) want to turn things off,
but have no need to make further customizations.

The ones I came up with are:

* `disable_nav_previous_next`: Turn off Previous/Next navigation links in the navbar
* `disable_nav_search`: Turn off Search in the navbar
* `disable_nav_site_name`: Turn off the site_name link in the navbar
* `disable_footer`: Turn off the footer entirely
* `disable_footer_except_revision`: Turn off the default footer message, but display the page revision date if it's available

Closes chrissimpkins#10
Closes chrissimpkins#97
@lewiseason lewiseason mentioned this issue Oct 24, 2020
Merged
chrissimpkins pushed a commit to lewiseason/cinder that referenced this issue Oct 26, 2020
@lewiseason @chrissimpkins
Add feature toggles to disable parts of the theme without overriding …
9b6b164 
…its files

Several toggles which are settable in `mkdocs.yml` to allow for turning
theme features off. Often you (or at least I!) want to turn things off,
but have no need to make further customizations.

The ones I came up with are:

* `disable_nav_previous_next`: Turn off Previous/Next navigation links in the navbar
* `disable_nav_search`: Turn off Search in the navbar
* `disable_nav_site_name`: Turn off the site_name link in the navbar
* `disable_footer`: Turn off the footer entirely
* `disable_footer_except_revision`: Turn off the default footer message, but display the page revision date if it's available

Closes chrissimpkins#10
Closes chrissimpkins#97
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add feature toggles to disable parts of the theme without overriding its files lewiseason/cinder
2 participants
@cudmore @chrissimpkins