Page MenuHomePhabricator

use markdown syntax for links
ClosedPublic

Authored by PiRK on Sep 17 2020, 14:21.

Details

Reviewers
deadalnix
Group Reviewers
Restricted Owners Package(Owns No Changed Paths)
Restricted Project
Commits
rABCb2699b177868: 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

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Owners added a reviewer: Restricted Owners Package.Sep 17 2020, 14:21
PiRK requested review of this revision.Sep 17 2020, 14:21
deadalnix added a subscriber: deadalnix.
deadalnix added inline comments.
INSTALL.md
6 ↗(On Diff #23549)

I don't think we support freebsd anymore. You can remove this (and remove the build-freebsd doc :) ).

This revision is now accepted and ready to land.Sep 17 2020, 14:34
This revision was automatically updated to reflect the committed changes.