git.iko.soy/typeable/pandoc
on master help sign in
Fix broken links in documents (#5473)
73efef5Shim Myeongseob
doc/customizing-pandoc.md+13−13
compare with master
unifiedsplit
@@ -46,14 +46,14 @@ There are several ways to set template variables:
46| accessible by filters: | no | yes | yes |
46| accessible by filters: | no | yes | yes |
47
47
48
48
49−[`--variable`]: http://pandoc.org/MANUAL.html#option--variable
49+[`--variable`]: https://pandoc.org/MANUAL.html#option--variable
50−[`--metadata`]: http://pandoc.org/MANUAL.html#option--metadata
50+[`--metadata`]: https://pandoc.org/MANUAL.html#option--metadata
51−[YAML metadata]: http://pandoc.org/MANUAL.html#extension-yaml_metadata_block
51+[YAML metadata]: https://pandoc.org/MANUAL.html#extension-yaml_metadata_block
52−[`--metadata-file`]: http://pandoc.org/MANUAL.html#option--metadata-file
52+[`--metadata-file`]: https://pandoc.org/MANUAL.html#option--metadata-file
53
53
54
54
55
55
56−For more information, see [Templates](/MANUAL.html#templates) in
56+For more information, see [Templates](https://pandoc.org/MANUAL.html#templates) in
57the pandoc manual.
57the pandoc manual.
58
58
59### Example: adding structured author data to HTML
59### Example: adding structured author data to HTML
@@ -73,7 +73,7 @@ For `docx`, `pptx` or `odt` documents, things are a bit more
73complicated. Instead of a single template file, you need to
73complicated. Instead of a single template file, you need to
74provide a customized `reference.docx/pptx/odt`.
74provide a customized `reference.docx/pptx/odt`.
75See the manual for the
75See 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.
77
77
78### Example: changing the font and line spacing in a Word docx
78### Example: changing the font and line spacing in a Word docx
79
79
@@ -111,9 +111,9 @@ use an interface built directly into pandoc, and must be written
111in the Lua language). If you are writing your own filters, it
111in the Lua language). If you are writing your own filters, it
112is best to use Lua filters, which are more portable (they
112is best to use Lua filters, which are more portable (they
113require only pandoc itself) and more efficient. See [Lua
113require 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
115you would prefer to write your filter in another language, see
115you 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
117filters.
117filters.
118
118
119There's a repository of lua filters at
119There's a repository of lua filters at
@@ -136,7 +136,7 @@ TODO
136## Generic Divs and Spans
136## Generic Divs and Spans
137
137
138TODO
138TODO
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
140that can be transformed with filters
140that can be transformed with filters
141
141
142### Example: colored text
142### Example: colored text
@@ -144,23 +144,23 @@ that can be transformed with filters
144
144
145### Example: custom styles in docx
145### Example: custom styles in docx
146
146
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)
148
148
149## Raw attributes
149## Raw attributes
150
150
151TODO
151TODO
152−[Generic raw attributes](/MANUAL.html#generic-raw-attribute):
152+[Generic raw attributes](https://pandoc.org/MANUAL.html#generic-raw-attribute):
153to include raw snippets
153to include raw snippets
154
154
155## Custom writers
155## Custom writers
156
156
157TODO
157TODO
158−[Custom writers](/MANUAL.html#custom-writers)
158+[Custom writers](https://pandoc.org/MANUAL.html#custom-writers)
159
159
160## Custom syntax highlighting
160## Custom syntax highlighting
161
161
162TODO
162TODO
163−[Custom syntax highlighting](/MANUAL.html#syntax-highlighting),
163+[Custom syntax highlighting](https://pandoc.org/MANUAL.html#syntax-highlighting),
164provided by the [skylighting
164provided by the [skylighting
165library](https://github.com/jgm/skylighting)
165library](https://github.com/jgm/skylighting)
166
166
doc/epub.md+9−9
@@ -53,7 +53,7 @@ please consider [buying a copy] to help support his excellent work.)
53You can find the markdown source for the book on its
53You can find the markdown source for the book on its
54[github site]. Let's get a copy of the whole repository:[^1]
54[github site]. Let's get a copy of the whole repository:[^1]
55
55
56− git clone http://github.com/progit/progit.git
56+ git clone https://github.com/progit/progit.git
57
57
58[^1]: If you don't have [git], you can browse to the [github site] and
58[^1]: If you don't have [git], you can browse to the [github site] and
59click "Download Source" to get the same files in a zip or tar archive.
59click "Download Source" to get the same files in a zip or tar archive.
@@ -105,7 +105,7 @@ language: en-US
105...
105...
106```
106```
107
107
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
109above these fields.
109above these fields.
110
110
111Now run pandoc to make the ebook, using our title page and modified
111Now 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`)
144or target readers that don't support MathML. Then you should try using the
144or target readers that don't support MathML. Then you should try using the
145`--webtex` option, which will use a web service to convert the TeX to an image.
145`--webtex` option, which will use a web service to convert the TeX to an image.
146
146
147−[KindleGen]: http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621
147+[KindleGen]: https://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211
148−[EPUB]: http://en.wikipedia.org/wiki/EPUB
148+[EPUB]: https://en.wikipedia.org/wiki/EPUB
149[Pro Git]: https://git-scm.com/book/en/v2
149[Pro Git]: https://git-scm.com/book/en/v2
150−[Creative Commons]: http://creativecommons.org/
150+[Creative Commons]: https://creativecommons.org/
151[buying a copy]: https://git-scm.com/book/en/v2
151[buying a copy]: https://git-scm.com/book/en/v2
152−[github site]: http://github.com/progit/progit
152+[github site]: https://github.com/progit/progit
153−[git]: http://git-scm.com
153+[git]: https://git-scm.com
154−[Dublin Core metadata elements]: http://dublincore.org/documents/dces/
154+[Dublin Core metadata elements]: https://dublincore.org/documents/dces/
155−[User's Guide]: MANUAL.html
155+[User's Guide]: https://pandoc.org/MANUAL.html
156
156
doc/filters.md+6−6
@@ -104,7 +104,7 @@ metadata like title, authors, and date) and a list of `Block`
104Each has as its content a list of `Inline` elements. For more details on
104Each has as its content a list of `Inline` elements. For more details on
105the pandoc AST, see the [haddock documentation for `Text.Pandoc.Definition`].
105the pandoc AST, see the [haddock documentation for `Text.Pandoc.Definition`].
106
106
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
108
108
109Here's a short Haskell script that reads markdown, changes level
109Here's a short Haskell script that reads markdown, changes level
1102+ headers to regular paragraphs, and writes the result as markdown.
1102+ headers to regular paragraphs, and writes the result as markdown.
@@ -141,7 +141,7 @@ our `behead` function (a function from `Block` to `Block`) to
141a transformation on whole `Pandoc` documents.
141a transformation on whole `Pandoc` documents.
142(See the [haddock documentation for `Text.Pandoc.Walk`].)
142(See the [haddock documentation for `Text.Pandoc.Walk`].)
143
143
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
145
145
146# Queries: listing URLs
146# Queries: listing URLs
147
147
@@ -307,10 +307,10 @@ Note that, although these parameters are not used in this example,
307the document's metadata.
307the document's metadata.
308
308
309There are many examples of python filters in [the pandocfilters
309There are many examples of python filters in [the pandocfilters
310−repository](http://github.com/jgm/pandocfilters).
310+repository](https://github.com/jgm/pandocfilters).
311
311
312For a more Pythonic alternative to pandocfilters, see
312For 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.
314Don't like Python? There are also ports of pandocfilters in
314Don't like Python? There are also ports of pandocfilters in
315[PHP](https://github.com/vinai/pandocfilters-php),
315[PHP](https://github.com/vinai/pandocfilters-php),
316[perl](https://metacpan.org/pod/Pandoc::Filter),
316[perl](https://metacpan.org/pod/Pandoc::Filter),
@@ -322,7 +322,7 @@ Starting with pandoc 2.0, pandoc includes built-in support for
322writing filters in lua. The lua interpreter is built in to
322writing filters in lua. The lua interpreter is built in to
323pandoc, so a lua filter does not require any additional software
323pandoc, so a lua filter does not require any additional software
324to run. See the [documentation on lua
324to run. See the [documentation on lua
325−filters](lua-filters.html).
325+filters](https://pandoc.org/lua-filters.html).
326
326
327# Include files
327# Include files
328
328
@@ -382,7 +382,7 @@ from an `Inline` element to a list of `Inline` elements.
382# A filter for ruby text
382# A filter for ruby text
383
383
384Finally, here's a nice real-world example, developed on the
384Finally, 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:
386
386
387> I'm interested in using pandoc to turn my markdown notes on Japanese
387> I'm interested in using pandoc to turn my markdown notes on Japanese
388> into nicely set HTML and (Xe)LaTeX. With HTML5, ruby (typically used to
388> 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
5
5
6This document is for people who are unfamiliar with command line
6This document is for people who are unfamiliar with command line
7tools. Command-line experts can go straight to the [User's
7tools. 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.
9
9
10# Step 1: Install pandoc
10# Step 1: Install pandoc
11
11
12First, install pandoc, following the [instructions for
12First, install pandoc, following the [instructions for
13−your platform](installing.html).
13+your platform](https://pandoc.org/installing.html).
14
14
15# Step 2: Open a terminal
15# Step 2: Open a terminal
16
16
@@ -212,9 +212,9 @@ Now save your file as `test1.md` in the directory
212
212
213Note: If you use plain text a lot, you'll want a better editor than
213Note: If you use plain text a lot, you'll want a better editor than
214`Notepad` or `TextEdit`. You might want to look at
214`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
216to put in some time learning an unfamiliar interface)
216to 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).
218
218
219# Step 6: Converting a file
219# Step 6: Converting a file
220
220
@@ -271,8 +271,8 @@ Pandoc knows you're trying to create a LaTeX document, because of the
271Now try creating a Word document (with extension `docx`).
271Now try creating a Word document (with extension `docx`).
272
272
273If you want to create a PDF, you'll need to have LaTeX installed.
273If you want to create a PDF, you'll need to have LaTeX installed.
274−(See [MacTeX](http://tug.org/mactex/) on OS X,
274+(See [MacTeX](https://tug.org/mactex/) on OS X,
275−[MiKTeX](http://miktex.org) on Windows, or install the texlive
275+[MiKTeX](https://miktex.org) on Windows, or install the texlive
276package in linux.) Then do
276package in linux.) Then do
277
277
278 pandoc test1.md -s -o test1.pdf
278 pandoc test1.md -s -o test1.pdf
@@ -281,7 +281,7 @@ package in linux.) Then do
281
281
282You now know the basics. Pandoc has a lot of options. At this point
282You now know the basics. Pandoc has a lot of options. At this point
283you can start to learn more about them by reading the
283you 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).
285
285
286Here's an example. The `--mathml` option causes pandoc to
286Here's an example. The `--mathml` option causes pandoc to
287convert TeX math into MathML. Type
287convert TeX math into MathML. Type
@@ -311,8 +311,8 @@ to get the pandoc manual page. All of this information is also
311in the User's Guide.
311in the User's Guide.
312
312
313If you get stuck, you can always ask questions on the
313If you get stuck, you can always ask questions on the
314−[pandoc-discuss](http://groups.google.com/group/pandoc-discuss)
314+[pandoc-discuss](https://groups.google.com/group/pandoc-discuss)
315−mailing list. But be sure to check the [FAQs](faqs.html) first,
315+mailing list. But be sure to check the [FAQs](https://pandoc.org/faqs.html) first,
316and search through the mailing list to see if your question has
316and search through the mailing list to see if your question has
317been answered before.
317been answered before.
318
318
doc/lua-filters.md+2−2
@@ -11,7 +11,7 @@ title: Pandoc Lua Filters
11Pandoc has long supported filters, which allow the pandoc
11Pandoc has long supported filters, which allow the pandoc
12abstract syntax tree (AST) to be manipulated between the parsing
12abstract syntax tree (AST) to be manipulated between the parsing
13and the writing phase. [Traditional pandoc
13and 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
15pandoc AST and produce an altered JSON representation of the
15pandoc AST and produce an altered JSON representation of the
16AST. They may be written in any programming language, and
16AST. They may be written in any programming language, and
17invoked from pandoc using the `--filter` option.
17invoked from pandoc using the `--filter` option.
@@ -508,7 +508,7 @@ end
508This filter replaces code blocks with class `abc` with images
508This filter replaces code blocks with class `abc` with images
509created by running their contents through `abcm2ps` and
509created by running their contents through `abcm2ps` and
510ImageMagick's `convert`. (For more on ABC notation, see
510ImageMagick's `convert`. (For more on ABC notation, see
511−<http://abcnotation.com>.)
511+<https://abcnotation.com>.)
512
512
513Images are added to the mediabag. For output to binary formats,
513Images are added to the mediabag. For output to binary formats,
514pandoc will use images in the mediabag. For textual formats, use
514pandoc 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.
459[Text.Pandoc.Logging]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-Logging.html
459[Text.Pandoc.Logging]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-Logging.html
460[Text.Pandoc.App]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-App.html
460[Text.Pandoc.App]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-App.html
461[Text.Pandoc.Error]: https://hackage.haskell.org/package/pandoc/docs/Text-Pandoc-Error.html
461[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