Skip to content

doc: fix edit page link & cleanup #1474

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

Merged
erisu merged 1 commit into from
Mar 2, 2026
Merged

doc: fix edit page link & cleanup #1474

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 11 additions & 59 deletions www/_layouts/docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,71 +49,23 @@
{% include toc_recursive_dropdown.html entries=TOCFILE my_entry=MY_ENTRY path_to_root=PATH_TO_ROOT %}
</ul>
</div>

{% comment %}
Show a single edit-link if the page has a specific edit-link.
{% endcomment %}
{% if page.edit_link %}
<a class="edit hidden-xs hidden-sm" href="{{ page.edit_link }}"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> {{ page.edit_text }}</a>

{% comment %}
Otherwise, show editing and translating options.

Edit-links obey the following rules:

if page in /dev/ or /latest/:
show edit link for /dev/ page in source language
if page not in source language:
show translation link for /dev/ page
else:
show edit link for the page in its version and language

{% endcomment %}
{% else %}

{% capture base_edit_link %}https://github.com/apache/cordova-docs/tree/master/www/{{ page.path }}{% endcapture %}
{% capture base_version %}/{{ page.version }}/{% endcapture %}
{% capture base_language %}/{{ page.language }}/{% endcapture %}
{% capture dev_version %}/dev/{% endcapture %}
{% capture src_language %}/{{ site.src_language }}/{% endcapture %}

{% comment %}
Edit-links for current pages in non-source languages
NOTE:
Pages that are under /dev/ or /latest/ (i.e. site.latest_docs_version) have page.current set to "true".
Remote Pages (E.g. Plugins, CLI, ...)
{% endcomment %}
{% if page.language != site.src_language and page.current %}

{% comment %}
Compute crowdin link
{% endcomment %}
{% capture page_path_prefix %}docs/{{ page.language }}/{{ page.version }}{% endcapture %}
{% assign page_path_end = page.path | split:"/" | last %}
{% assign crowdin_path = page.path | replace:page_path_prefix,"docs/en/dev" | replace:page_path_end,"" %}
{% capture crowdin_link %}https://crowdin.com/project/cordova/{{ page.language }}#/cordova-docs/{{ crowdin_path }}{% endcapture %}

{% assign edit_link = base_edit_link | replace:base_language,src_language | replace:base_version,dev_version %}

<a class="edit" href="{{ edit_link }}"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> {{ page.edit_source_text }}</a>
<a class="edit" href="{{ crowdin_link }}"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> {{ page.edit_translation_text }}</a>

{% assign edit_link = page.edit_link %}
{% assign edit_text = page.edit_text %}
{% else %}
{% comment %}
Edit-links for all other pages
Cordova-Doc Pages
{% endcomment %}
{% else %}

{% comment %}
Edit-link for latest version points to dev instead
{% endcomment %}
{% if page.version == site.latest_docs_version %}
{% assign edit_link = base_edit_link | replace:base_version,dev_version %}
{% else %}
{% assign edit_link = base_edit_link %}
{% endif %}

<a class="edit" href="{{ edit_link }}"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> {{ page.edit_source_text }}</a>
{% endif %}
{% assign edit_link = "https://github.com/apache/cordova-docs/tree/master/www/" | append: page.path %}
{% assign edit_text = page.edit_source_text %}
{% endif %}
{% comment %}
The edit icon will be hidden on small screens. (e.g. mobile)
{% endcomment %}
<a class="edit hidden-xs hidden-sm" href="{{ edit_link }}"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> {{ edit_text }}</a>
</div>

{% comment %}
Expand Down