HomePhabricator

use markdown syntax for links (part 2)

Description

use markdown syntax for links (part 2)

Summary:
Continuation of D7472. Use explicit markdown url syntax, and fix a few broken links.

Note: some links to non-.md files in developer-notes.md will appear as broken links on the website, but will work on github.com.
I did not remove them. This is an example that works on github:

[sha256_sse4::Transform](/src/crypto/sha256_sse4.cpp)

Test Plan:
Generate the abc_md_docs files:

SRC_DIR="/home/pierre/git/bitcoin-abc"
TOPLEVEL="/home/pierre/git/bitcoin-abc-website"
pushd "${SRC_DIR}"
ABC_MD_DOCS_BASE="${TOPLEVEL}/abc_md_docs"
mkdir -p "${ABC_MD_DOCS_BASE}"
FILES=($(git ls-files "*.md"))
for FILE in "${FILES[@]}"
do
  FILE_DST="${ABC_MD_DOCS_BASE}/${FILE}"
  mkdir -p "$(dirname ${FILE_DST})"

  NAME="${FILE}" \
  PERMALINK="/${FILE%.*}.html" \
  envsubst < "${TOPLEVEL}/scripts/md_docs_frontmatter.yml.in" > "${FILE_DST}"
  cat "${FILE}" >> "${FILE_DST}"
done
popd

Then test the links by running:

bundle exec jekyll serve

Reviewers: O1 Bitcoin ABC, #bitcoin_abc, deadalnix

Reviewed By: O1 Bitcoin ABC, #bitcoin_abc, deadalnix

Subscribers: deadalnix

Differential Revision: https://reviews.bitcoinabc.org/D7475

Details

Provenance
PiRKAuthored on Sep 17 2020, 15:41
PiRKPushed on Sep 17 2020, 18:49
Reviewer
Restricted Owners Package
Differential Revision
D7475: use markdown syntax for links (part 2)
Parents
rABCda60e76e598d: [land-bot] Call land-patch when generating automated commits
Branches
Unknown
Tags
Unknown