Added tips to Readme, adjusted margin for pdf

This commit is contained in:
Brian Khuu 2019-08-19 01:38:07 +10:00
parent f55c186ee9
commit 1bab351c21
2 changed files with 35 additions and 3 deletions

View File

@ -14,30 +14,47 @@ CSS_ARG = --css=$(CSS_FILE)
METADATA_ARG = --metadata-file=$(METADATA) METADATA_ARG = --metadata-file=$(METADATA)
ARGS = $(TOC) $(MATH_FORMULAS) $(CSS_ARG) $(METADATA_ARG) ARGS = $(TOC) $(MATH_FORMULAS) $(CSS_ARG) $(METADATA_ARG)
################################################################################
# Default Action
all: book all: book
################################################################################
book: epub html pdf book: epub html pdf
clean: clean:
rm -r $(BUILD) rm -r $(BUILD)
################################################################################
epub: $(BUILD)/epub/$(OUTPUT_FILENAME).epub epub: $(BUILD)/epub/$(OUTPUT_FILENAME).epub
html: $(BUILD)/html/$(OUTPUT_FILENAME).html html: $(BUILD)/html/$(OUTPUT_FILENAME).html
pdf: $(BUILD)/pdf/$(OUTPUT_FILENAME).pdf pdf: $(BUILD)/pdf/$(OUTPUT_FILENAME).pdf
$(BUILD)/epub/$(OUTPUT_FILENAME).epub: $(MAKEFILE) $(METADATA) $(CHAPTERS) $(CSS_FILE) $(IMAGES) \ ################################################################################
$(COVER_IMAGE)
$(BUILD)/epub/$(OUTPUT_FILENAME).epub: $(MAKEFILE) $(METADATA) $(CHAPTERS) $(CSS_FILE) $(IMAGES) $(COVER_IMAGE)
@echo ""
@echo "--- $@ building ---"
mkdir -p $(BUILD)/epub mkdir -p $(BUILD)/epub
pandoc $(ARGS) --epub-cover-image=$(COVER_IMAGE) -o $@ $(CHAPTERS) pandoc $(ARGS) --epub-cover-image=$(COVER_IMAGE) -o $@ $(CHAPTERS)
@echo "--- $@ complete ---"
$(BUILD)/html/$(OUTPUT_FILENAME).html: $(MAKEFILE) $(METADATA) $(CHAPTERS) $(CSS_FILE) $(IMAGES) $(BUILD)/html/$(OUTPUT_FILENAME).html: $(MAKEFILE) $(METADATA) $(CHAPTERS) $(CSS_FILE) $(IMAGES)
@echo ""
@echo "--- $@ building ---"
mkdir -p $(BUILD)/html mkdir -p $(BUILD)/html
pandoc $(ARGS) --standalone --to=html5 -o $@ $(CHAPTERS) pandoc $(ARGS) --standalone --to=html5 -o $@ $(CHAPTERS)
cp -R $(IMAGES_FOLDER)/ $(BUILD)/html/$(IMAGES_FOLDER)/ cp -R $(IMAGES_FOLDER)/ $(BUILD)/html/$(IMAGES_FOLDER)/
cp $(CSS_FILE) $(BUILD)/html/$(CSS_FILE) cp $(CSS_FILE) $(BUILD)/html/$(CSS_FILE)
@echo "--- $@ complete ---"
$(BUILD)/pdf/$(OUTPUT_FILENAME).pdf: $(MAKEFILE) $(METADATA) $(CHAPTERS) $(CSS_FILE) $(IMAGES) $(BUILD)/pdf/$(OUTPUT_FILENAME).pdf: $(MAKEFILE) $(METADATA) $(CHAPTERS) $(CSS_FILE) $(IMAGES)
@echo ""
@echo "--- $@ building ---"
mkdir -p $(BUILD)/pdf mkdir -p $(BUILD)/pdf
pandoc $(ARGS) -V documentclass=$(LATEX_CLASS) -o $@ $(CHAPTERS) pandoc $(ARGS) -V documentclass=$(LATEX_CLASS) -V geometry:margin=1in -o $@ $(CHAPTERS)
@echo "--- $@ complete ---"

View File

@ -93,6 +93,21 @@ This is the second subsection.
Each title (*#*) will represent a chapter, while each subtitle (*##*) will represent a chapter's section. You can use as many levels of sections as markdown supports. Each title (*#*) will represent a chapter, while each subtitle (*##*) will represent a chapter's section. You can use as many levels of sections as markdown supports.
#### For manual control over page ordering
You may prefer to have manual control over page ordering instead of using numeric prefixes.
To do so, replace `CHAPTERS = chapters/*.md` in the Makefile with:
```
CHAPTERS += $(addprefix ./chapters/,\
01-introduction.md\
02-installation.md\
03-usage.md\
04-references.md\
)
```
#### Links between chapters #### Links between chapters
Anchor links can be used to link chapters within the book: Anchor links can be used to link chapters within the book: