use markdown syntax for links (part 2)
ClosedPublic
Actions

Authored by PiRK on Sep 17 2020, 15:49.

Details

Reviewers

Group Reviewers

Restricted Owners Package	(Owns No Changed Paths)
Restricted Project

Commits

rABC66d469b873fb: 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

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

PiRK created this revision.Sep 17 2020, 15:49

Owners added a reviewer: Restricted Owners Package.Sep 17 2020, 15:49

Herald added a reviewer: Restricted Project. · View Herald TranscriptSep 17 2020, 15:49

PiRK requested review of this revision.Sep 17 2020, 15:49

Harbormaster completed remote builds in B12772: Diff 23553.Sep 17 2020, 16:02

fix formatting of commit message

In D7475#177686, @PiRK wrote:

fix formatting of commit message

That didn't work. This should be the updated diff 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: