[docs] Add GitHub star button to documentation (#553)

release-2.0
Jark Wu 3 years ago committed by GitHub
parent 7ca30b839e
commit 27812cfd17
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

File diff suppressed because one or more lines are too long

@ -18,38 +18,43 @@
{% if READTHEDOCS or display_lower_left %} {% if READTHEDOCS or display_lower_left %}
{# Add rst-badge after rst-versions for small badge style. #} {# Add rst-badge after rst-versions for small badge style. #}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span> <span class="fa fa-book"> Read the Docs</span>
version: {{ current_version }} version: {{ current_version }}
<span class="fa fa-caret-down"></span> <span class="fa fa-caret-down"></span>
</span> </span>
<div class="rst-other-versions"> <div class="rst-other-versions">
{% if versions %} {% if versions %}
<dl> <dl>
<dt>{{ _('Versions') }}</dt> <dt>{{ _('Versions') }}</dt>
{% for slug, url in versions %} {% for slug, url in versions %}
{% if slug == current_version %} <strong> {% endif %} {% if slug == current_version %} <strong> {% endif %}
<dd><a href="{{ url }}">{{ slug }}</a></dd> <dd><a href="{{ url }}">{{ slug }}</a></dd>
{% if slug == current_version %} </strong> {% endif %} {% if slug == current_version %} </strong> {% endif %}
{% endfor %} {% endfor %}
</dl> </dl>
{% endif %} {% endif %}
{% if READTHEDOCS %} {% if READTHEDOCS %}
<dl> <dl>
<dt>{{ _('On Read the Docs') }}</dt> <dt>{{ _('On Read the Docs') }}</dt>
<dd> <dd>
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a> <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{
</dd> _('Project Home') }}</a>
<dd> </dd>
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a> <dd>
</dd> <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{
</dl> _('Builds') }}</a>
{% endif %} </dd>
<hr/> </dl>
{% trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.{% endtrans %} {% endif %}
<hr/>
{% trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the
Docs</a>.{% endtrans %}
</div> </div>
</div> </div>
{% endif %} {% endif %}
<!-- Place this tag in your head or just before your close body tag. -->
<script async defer
src="https://ververica.github.io/{{ github_repo }}/{{ current_version }}/_static/button.js"></script>

@ -0,0 +1 @@
# <a class="github-button" href="https://github.com/ververica/flink-cdc-connectors" data-color-scheme="no-preference: dark_high_contrast; light: dark_high_contrast; dark: dark_high_contrast;" data-size="large" data-show-count="true" aria-label="Star ververica/flink-cdc-connectors on GitHub">Star</a>

@ -8,6 +8,7 @@ content/connectors/index
content/formats/index content/formats/index
content/tutorials/index content/tutorials/index
content/downloads content/downloads
content/githublink
``` ```
# Indices and Search # Indices and Search

@ -184,6 +184,7 @@ under the License.
<exclude>docs/Dockerfile</exclude> <exclude>docs/Dockerfile</exclude>
<exclude>docs/make.bat</exclude> <exclude>docs/make.bat</exclude>
<exclude>docs/_templates/version.html</exclude> <exclude>docs/_templates/version.html</exclude>
<exclude>docs/_static/button.js</exclude>
<!-- Tests --> <!-- Tests -->
<exclude>**/*.txt</exclude> <exclude>**/*.txt</exclude>
</excludes> </excludes>

Loading…
Cancel
Save