Docs: Add API Reference as top-level nav #2180
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- for local build, just point to http://localhost:30870/api/redoc - for deployment, copy locally from prod and serve at /api/ - add copy-api-docs.sh to copy openapi.json, redoc and logo to /api/ dir - for local testing, run copy-api-docs.sh and then run mkdocs serve - fixes #1582
emma-sg
approved these changes
Nov 27, 2024
Comment on lines
+10
to
+15
| if [ -n $ENABLE_ANALYTICS ]; then | ||
| SCRIPT_1=' <script defer data-domain=\"docs.browsertrix.com\" src=\"https://p.webrecorder.net/js/script.outbound-links.js\"></script>' | ||
| SCRIPT_2=' <script>window.plausible = window.plausible || function () { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>' | ||
| awk "1;/<head>/{ print \"$SCRIPT_1\"; print \"$SCRIPT_2\" }" $TARGET/index.html > $TARGET/index.html.new | ||
| mv $TARGET/index.html.new $TARGET/index.html | ||
| fi |
There was a problem hiding this comment.
A little messy but it looks like we'd have to fork redoc's html template to do this when building it, so whatever
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
can either link to redoc hosted elsewhere or make a local copy: