73efef5 · typeable/pandoc

git.iko.soy/typeable/pandoc

Fix broken links in documents (#5473)

Fix broken links in doc/epub.md, doc/getting-started.md, doc/customizing-pandoc.md, doc/using-the-pandoc-api.md. Also, use absolute links to pandoc.org when possible, so that the links can be followed by people viewing these documents on GitHub.

commit73efef589a14616972cf4e3b96b3b1dc366b80f1 authorShim Myeongseob <zzangsim231@gmail.com> dateThu 2 May 2019, 09:09 (8 years ago) parenta203230

6 files changed+40−40

compare with master

unifiedsplit

doc/customizing-pandoc.md+13−13 doc/epub.md+9−9 doc/filters.md+6−6 doc/getting-started.md+9−9 doc/lua-filters.md+2−2 doc/using-the-pandoc-api.md+1−1

doc/customizing-pandoc.md+13−13

@@ -46,14 +46,14 @@ There are several ways to set template variables:

4646| accessible by filters: | no | yes | yes |

4747

4848

49−[`--variable`]: http://pandoc.org/MANUAL.html#option--variable

50−[`--metadata`]: http://pandoc.org/MANUAL.html#option--metadata

51−[YAML metadata]: http://pandoc.org/MANUAL.html#extension-yaml_metadata_block

52−[`--metadata-file`]: http://pandoc.org/MANUAL.html#option--metadata-file

49+[`--variable`]: https://pandoc.org/MANUAL.html#option--variable

50+[`--metadata`]: https://pandoc.org/MANUAL.html#option--metadata

51+[YAML metadata]: https://pandoc.org/MANUAL.html#extension-yaml_metadata_block

52+[`--metadata-file`]: https://pandoc.org/MANUAL.html#option--metadata-file

5353

5454

5555

56−For more information, see [Templates](/MANUAL.html#templates) in

56+For more information, see [Templates](https://pandoc.org/MANUAL.html#templates) in

5757the pandoc manual.

5858

5959### Example: adding structured author data to HTML

@@ -73,7 +73,7 @@ For `docx`, `pptx` or `odt` documents, things are a bit more

7373complicated. Instead of a single template file, you need to

7474provide a customized `reference.docx/pptx/odt`.

7575See the manual for the

76−[`--reference-doc`](/MANUAL.html#option--reference-doc) option.

76+[`--reference-doc`](https://pandoc.org/MANUAL.html#option--reference-doc) option.

7777

7878### Example: changing the font and line spacing in a Word docx

7979

@@ -111,9 +111,9 @@ use an interface built directly into pandoc, and must be written

111111in the Lua language). If you are writing your own filters, it

112112is best to use Lua filters, which are more portable (they

113113require only pandoc itself) and more efficient. See [Lua

114−filters](lua-filters.html) for documentation and examples. If

114+filters](https://pandoc.org/lua-filters.html) for documentation and examples. If

115115you would prefer to write your filter in another language, see

116−[Filters](filters.html) for a gentle introduction to JSON

116+[Filters](https://pandoc.org/filters.html) for a gentle introduction to JSON

117117filters.

118118

119119There's a repository of lua filters at

@@ -136,7 +136,7 @@ TODO

136136## Generic Divs and Spans

137137

138138TODO

139−[Divs and Spans](/MANUAL.html#divs-and-spans): generic blocks

139+[Divs and Spans](https://pandoc.org/MANUAL.html#divs-and-spans): generic blocks

140140that can be transformed with filters

141141

142142### Example: colored text

@@ -144,23 +144,23 @@ that can be transformed with filters

144144

145145### Example: custom styles in docx

146146

147−[Custom Styles in Docx](/MANUAL.html#custom-styles-in-docx)

147+[Custom Styles in Docx](https://pandoc.org/MANUAL.html#custom-styles-in-docx)

148148

149149## Raw attributes

150150

151151TODO

152−[Generic raw attributes](/MANUAL.html#generic-raw-attribute):

152+[Generic raw attributes](https://pandoc.org/MANUAL.html#generic-raw-attribute):

153153to include raw snippets

154154

155155## Custom writers

156156

157157TODO

158−[Custom writers](/MANUAL.html#custom-writers)

158+[Custom writers](https://pandoc.org/MANUAL.html#custom-writers)

159159

160160## Custom syntax highlighting

161161

162162TODO

163−[Custom syntax highlighting](/MANUAL.html#syntax-highlighting),

163+[Custom syntax highlighting](https://pandoc.org/MANUAL.html#syntax-highlighting),

164164provided by the [skylighting

165165library](https://github.com/jgm/skylighting)

166166

doc/epub.md+9−9

@@ -53,7 +53,7 @@ please consider [buying a copy] to help support his excellent work.)

5353You can find the markdown source for the book on its

5454[github site]. Let's get a copy of the whole repository:[^1]

5555

56− git clone http://github.com/progit/progit.git

56+ git clone https://github.com/progit/progit.git

5757

5858[^1]: If you don't have [git], you can browse to the [github site] and

5959click "Download Source" to get the same files in a zip or tar archive.

@@ -105,7 +105,7 @@ language: en-US

105105...

106106```

107107

108−See the [User's Guide](MANUAL.html#epub-metadata) for more information

108+See the [User's Guide](https://pandoc.org/MANUAL.html#epub-metadata) for more information

109109above these fields.

110110

111111Now run pandoc to make the ebook, using our title page and modified

@@ -144,13 +144,13 @@ Of course, this isn't much help if you want EPUB2 output (`pandoc -t epub2`)

144144or target readers that don't support MathML. Then you should try using the

145145`--webtex` option, which will use a web service to convert the TeX to an image.

146146

147−[KindleGen]: http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621

148−[EPUB]: http://en.wikipedia.org/wiki/EPUB

147+[KindleGen]: https://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211

148+[EPUB]: https://en.wikipedia.org/wiki/EPUB

149149[Pro Git]: https://git-scm.com/book/en/v2

150−[Creative Commons]: http://creativecommons.org/

150+[Creative Commons]: https://creativecommons.org/

151151[buying a copy]: https://git-scm.com/book/en/v2

152−[github site]: http://github.com/progit/progit

153−[git]: http://git-scm.com

154−[Dublin Core metadata elements]: http://dublincore.org/documents/dces/

155−[User's Guide]: MANUAL.html

152+[github site]: https://github.com/progit/progit

153+[git]: https://git-scm.com

154+[Dublin Core metadata elements]: https://dublincore.org/documents/dces/

155+[User's Guide]: https://pandoc.org/MANUAL.html

156156

doc/filters.md+6−6

@@ -104,7 +104,7 @@ metadata like title, authors, and date) and a list of `Block`

104104Each has as its content a list of `Inline` elements. For more details on

105105the pandoc AST, see the [haddock documentation for `Text.Pandoc.Definition`].

106106

107−[haddock documentation for `Text.Pandoc.Definition`]: http://hackage.haskell.org/package/pandoc-types

107+[haddock documentation for `Text.Pandoc.Definition`]: https://hackage.haskell.org/package/pandoc-types

108108

109109Here's a short Haskell script that reads markdown, changes level

1101102+ headers to regular paragraphs, and writes the result as markdown.

@@ -141,7 +141,7 @@ our `behead` function (a function from `Block` to `Block`) to

141141a transformation on whole `Pandoc` documents.

142142(See the [haddock documentation for `Text.Pandoc.Walk`].)

143143

144−[haddock documentation for `Text.Pandoc.Walk`]: http://hackage.haskell.org/package/pandoc-types

144+[haddock documentation for `Text.Pandoc.Walk`]: https://hackage.haskell.org/package/pandoc-types

145145

146146# Queries: listing URLs

147147

@@ -307,10 +307,10 @@ Note that, although these parameters are not used in this example,

307307the document's metadata.

308308

309309There are many examples of python filters in [the pandocfilters

310−repository](http://github.com/jgm/pandocfilters).

310+repository](https://github.com/jgm/pandocfilters).

311311

312312For a more Pythonic alternative to pandocfilters, see

313−the [panflute](http://scorreia.com/software/panflute/) library.

313+the [panflute](https://pypi.org/project/panflute) library.

314314Don't like Python? There are also ports of pandocfilters in

315315[PHP](https://github.com/vinai/pandocfilters-php),

316316[perl](https://metacpan.org/pod/Pandoc::Filter),

@@ -322,7 +322,7 @@ Starting with pandoc 2.0, pandoc includes built-in support for

322322writing filters in lua. The lua interpreter is built in to

323323pandoc, so a lua filter does not require any additional software

324324to run. See the [documentation on lua

325−filters](lua-filters.html).

325+filters](https://pandoc.org/lua-filters.html).

326326

327327# Include files

328328

@@ -382,7 +382,7 @@ from an `Inline` element to a list of `Inline` elements.

382382# A filter for ruby text

383383

384384Finally, here's a nice real-world example, developed on the

385−[pandoc-discuss](http://groups.google.com/group/pandoc-discuss/browse_thread/thread/7baea325565878c8) list. Qubyte wrote:

385+[pandoc-discuss](https://groups.google.com/group/pandoc-discuss/browse_thread/thread/7baea325565878c8) list. Qubyte wrote:

386386

387387> I'm interested in using pandoc to turn my markdown notes on Japanese

388388> into nicely set HTML and (Xe)LaTeX. With HTML5, ruby (typically used to

doc/getting-started.md+9−9

@@ -5,12 +5,12 @@ author: John MacFarlane

66This document is for people who are unfamiliar with command line

77tools. Command-line experts can go straight to the [User's

8−Guide](README.html) or the pandoc man page.

8+Guide](https://pandoc.org/MANUAL.html) or the pandoc man page.

1010# Step 1: Install pandoc

1111

1212First, install pandoc, following the [instructions for

13−your platform](installing.html).

13+your platform](https://pandoc.org/installing.html).

1414

1515# Step 2: Open a terminal

1616

@@ -212,9 +212,9 @@ Now save your file as `test1.md` in the directory

212212

213213Note: If you use plain text a lot, you'll want a better editor than

214214`Notepad` or `TextEdit`. You might want to look at

215−[Sublime Text](http://www.sublimetext.com/) or (if you're willing

215+[Sublime Text](https://www.sublimetext.com/) or (if you're willing

216216to put in some time learning an unfamiliar interface)

217−[Vim](http://www.vim.org) or [Emacs](http://www.gnu.org/software/emacs).

217+[Vim](https://www.vim.org) or [Emacs](https://www.gnu.org/software/emacs).

218218

219219# Step 6: Converting a file

220220

@@ -271,8 +271,8 @@ Pandoc knows you're trying to create a LaTeX document, because of the

271271Now try creating a Word document (with extension `docx`).

272272

273273If you want to create a PDF, you'll need to have LaTeX installed.

274−(See [MacTeX](http://tug.org/mactex/) on OS X,

275−[MiKTeX](http://miktex.org) on Windows, or install the texlive

274+(See [MacTeX](https://tug.org/mactex/) on OS X,

275+[MiKTeX](https://miktex.org) on Windows, or install the texlive

276276package in linux.) Then do

277277

278278 pandoc test1.md -s -o test1.pdf

@@ -281,7 +281,7 @@ package in linux.) Then do

281281

282282You now know the basics. Pandoc has a lot of options. At this point

283283you can start to learn more about them by reading the

284−[User's Guide](README.html).

284+[User's Guide](https://pandoc.org/MANUAL.html).

285285

286286Here's an example. The `--mathml` option causes pandoc to

287287convert TeX math into MathML. Type

@@ -311,8 +311,8 @@ to get the pandoc manual page. All of this information is also

311311in the User's Guide.

312312

313313If you get stuck, you can always ask questions on the

314−[pandoc-discuss](http://groups.google.com/group/pandoc-discuss)

315−mailing list. But be sure to check the [FAQs](faqs.html) first,

314+[pandoc-discuss](https://groups.google.com/group/pandoc-discuss)

315+mailing list. But be sure to check the [FAQs](https://pandoc.org/faqs.html) first,

316316and search through the mailing list to see if your question has

317317been answered before.

318318

doc/lua-filters.md+2−2

@@ -11,7 +11,7 @@ title: Pandoc Lua Filters

1111Pandoc has long supported filters, which allow the pandoc

1212abstract syntax tree (AST) to be manipulated between the parsing

1313and the writing phase. [Traditional pandoc

14−filters](filters.html) accept a JSON representation of the

14+filters](https://pandoc.org/filters.html) accept a JSON representation of the

1515pandoc AST and produce an altered JSON representation of the

1616AST. They may be written in any programming language, and

1717invoked from pandoc using the `--filter` option.

@@ -508,7 +508,7 @@ end

508508This filter replaces code blocks with class `abc` with images

509509created by running their contents through `abcm2ps` and

510510ImageMagick's `convert`. (For more on ABC notation, see

511−<http://abcnotation.com>.)

511+<https://abcnotation.com>.)

512512

513513Images are added to the mediabag. For output to binary formats,

514514pandoc will use images in the mediabag. For textual formats, use

doc/using-the-pandoc-api.md+1−1

@@ -459,4 +459,4 @@ structure and calling this function.

459459[Text.Pandoc.Logging]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-Logging.html

460460[Text.Pandoc.App]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-App.html

461461[Text.Pandoc.Error]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-Error.html

462−[Text.Pandoc.Writers.Shared]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-Writers.Shared.html

462+[Text.Pandoc.Writers.Shared]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-Writers-Shared.html