Files
xrpl-dev-portal/tool/make_common_links_snippet.sh
mDuo13 96121303b2 Create script to migrate links and content syntax
Add tool/migrate.sh as a one-stop conversion script for the whole repo.
This script's duties include:

- Changing all links from their old (.html) paths to new paths
- Converting most Dactyl-specific syntax to Redocly equivalents
- Generating Redocly sidebar and redirects YAML files

This script is meant to be run from the repo top. It replaces syntax
in-place. Unless this is the final migration phase, the results of
running the migration script should be committed in a separate commit
whose message starts with '[DROP]' so it can be re-run on the latest
version of the master branch during rebasing.

Many commits have been squashed into this one, including:

- Add tool/migrate_links.sh as a one-stop conversion script for links.
- Enable the update_links filter in dactyl config but make it inactive
  unless you pass the appropriate vars
- Hack include_svg script to assume content/img instead of img

[FOLD] Migration scripting improvements:

- Roll scripting into all-in-one tool/migrate.sh
- Script moving/renaming Japanese snippets into @i18n
- Link replacment in snippets
- Handle links with query params
- Handle ref-links with anchors
- Remove some macro syntax that breaks Redocly
- Follow internal redirects in link replacement
- Handle links to some non-md pages

[FOLD] Migration script: handle more reflinks & imgs

[FOLD] tweak link migration

[FOLD] Fix substitution of reflinks

Add sidebar script

[FOLD] Fix link migration and whitespace noisiness

[FOLD] Link migration: auto-generate better link replacements

[FOLD] Convert badge syntax

[FOLD] Migration script: handle :not_enabled: syntax

[FOLD] Script generation of redirects

[FOLD] Migration script: make reusable common links

[FOLD] Fix common links code & conversion script comments

[FOLD] Add more non-md links

[FOLD] Fix filter_update_links syntax

[FOLD] Fix script's common links include placement

[FOLD] Migration script: update badge replacement to work w/ common-links

[FOLD] Fix ordering of converting common-links vs partials

[FOLD] Fix link substitution in common-links and fix trailing /index in redirects
2024-01-31 16:07:14 -08:00

21 lines
679 B
Bash
Executable File

#!/bin/bash
echo '# Common links
{% include "_snippets/rippled-api-links.md" %}
{% include "_snippets/tx-type-links.md" %}
{% include "_snippets/rippled_versions.md" %}
' > content/common-links-gen.md
dactyl_build --pages content/common-links-gen.md --md -q
rm content/common-links-gen.md
#sed -i -r 's/\[|\]/"/g' out/autosubs_gen.md
sed -i 's/# Common links//' out/common-links-gen.md
sed -i -r 's/<!--.*-->//' out/common-links-gen.md
#sed -i -r 's/ "BADGE_.*"//' out/common-links-gen.md
cat out/common-links-gen.md | sort | uniq > content/_snippets/common-links.md
sed -i -r 's/^\s+//' content/_snippets/common-links.md
sed -i '/./,$!d' content/_snippets/common-links.md