Skip to content

Add global deprecation banner to all Entity docs pages with OpenAPI link #409

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

Open
Copilot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add global deprecation banner to all Entity docs pages with OpenAPI link #409

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
25 changes: 24 additions & 1 deletion _includes/head_custom.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
<link rel="shortcut icon" type="image/png" href="/mocoapp-api-docs/favicon.png">
<link rel="shortcut icon" type="image/png" href="/mocoapp-api-docs/favicon.png">
<style>
.entity-deprecation-note {
margin: 1rem 0;
padding: 0.75rem 1rem;
border-left: 4px solid #e4af0a;
background: #fff8db;
}
</style>
<script>
document.addEventListener("DOMContentLoaded", function () {
if (!window.location.pathname.includes("/sections/")) return;
if (document.querySelector(".entity-deprecation-note")) return;

var heading = document.querySelector("main h1");
if (!heading) return;

var note = document.createElement("p");
note.className = "entity-deprecation-note";
note.innerHTML =
'This API documentation is being deprecated. Please use our <a href="https://docs.mocoapp.com/api/docs/v1#description/introduction">OpenAPI Documentation</a> instead.';
heading.insertAdjacentElement("afterend", note);
});
</script>