Skip to content

Commit

Permalink
doc: remove old vendorized marked module and replace with 0.8.2
Browse files Browse the repository at this point in the history
This change is needed because in 1.8.3 we are going to introduce Markdown tables
in the documentation (#3873 and #3921), and the old marked version did not
support generating them.

Instead of committing the marked source code here, we live install from npm if
needed via the Makefile.

n.b.: at the time of this change, marked latest version is 1.0.0, released a few
      days ago. I am updating to the version immediately before that (0.8.2),
      because in 1.0.0 the hyperlinks in the Table of Contents do not work
      (probably a bug in that version).
  • Loading branch information
muxator committed Apr 24, 2020
1 parent 13dddde commit db77302
Show file tree
Hide file tree
Showing 13 changed files with 22 additions and 1,000 deletions.
9 changes: 8 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@ docassets = $(addprefix out/,$(wildcard doc/assets/*))
VERSION = $(shell node -e "console.log( require('./src/package.json').version )")
UNAME := $(shell uname -s)

docs: $(outdoc_files) $(docassets)
ensure_marked_is_installed:
set -eu; \
hash npm; \
if [ $(shell npm list --prefix bin/doc >/dev/null 2>/dev/null; echo $$?) -ne "0" ]; then \
npm ci --prefix=bin/doc; \
fi

docs: ensure_marked_is_installed $(outdoc_files) $(docassets)

out/doc/assets/%: doc/assets/%
mkdir -p $(@D)
Expand Down
1 change: 0 additions & 1 deletion bin/doc/node_modules/.bin/marked

This file was deleted.

2 changes: 0 additions & 2 deletions bin/doc/node_modules/marked/.npmignore

This file was deleted.

19 changes: 0 additions & 19 deletions bin/doc/node_modules/marked/LICENSE

This file was deleted.

9 changes: 0 additions & 9 deletions bin/doc/node_modules/marked/Makefile

This file was deleted.

135 changes: 0 additions & 135 deletions bin/doc/node_modules/marked/README.md

This file was deleted.

115 changes: 0 additions & 115 deletions bin/doc/node_modules/marked/bin/marked

This file was deleted.

1 change: 0 additions & 1 deletion bin/doc/node_modules/marked/index.js

This file was deleted.

Loading

0 comments on commit db77302

Please sign in to comment.