fix MarkDown links and code formatting
ClosedPublic
Actions

Authored by PiRK on Sep 18 2020, 14:42.

Details

Reviewers

Group Reviewers

Restricted Owners Package	(Owns No Changed Paths)
Restricted Project

Commits

rABC82bd2bd3c369: fix MarkDown links and code formatting

Summary

Continuation of D7475. Use explicit markdown syntax for links to improve make them render correctly both in github and auto-generated html pages on bitcoinabc.org.

I also changed a URL in doc/README.srt to point the ABC developer doxygen documentation rather than the Core one.

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

PiRK created this revision.Sep 18 2020, 14:42

Owners added a reviewer: Restricted Owners Package.Sep 18 2020, 14:42

Herald added a reviewer: Restricted Project. · View Herald TranscriptSep 18 2020, 14:42

PiRK requested review of this revision.Sep 18 2020, 14:42

Harbormaster completed remote builds in B12795: Diff 23583.Sep 18 2020, 14:48

jasonbcox requested changes to this revision.Sep 18 2020, 18:48

jasonbcox added a subscriber: jasonbcox.

jasonbcox added inline comments.

src/seeder/README.md
20 ↗	(On Diff #23583)	Since this will be formatted as code, we don't need the preceding `$`. Please remove it. This way it's more easily copy-pasted into a terminal. Do the same for the other lines in this file.