HomePhabricator

use markdown syntax for links

Description

use markdown syntax for links

Summary: Raw urls do not appear as links on generated html pages (e.g. https://www.bitcoinabc.org/CONTRIBUTING.html). Using explicit markdown syntax for links solves this.

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/D7472

Details

Provenance
PiRKAuthored on Sep 17 2020, 13:59
PiRKPushed on Sep 17 2020, 14:48
Reviewer
Restricted Owners Package
Differential Revision
D7472: use markdown syntax for links
Parents
rABC17a50cbdbf21: [Automated] Update timing.json
Branches
Unknown
Tags
Unknown