##// END OF EJS Templates
add some detail in rst and markdown output
MinRK -
Show More
@@ -31,25 +31,31 b' The currently supported export formats are:'
31 31 * ``--to html``
32 32
33 33 - ``--template full`` (default)
34
34 35 A full static HTML render of the notebook.
35 36 This looks very similar to the interactive view.
36 37
37 38 - ``--template basic``
39
38 40 Simplified HTML, useful for embedding in webpages, blogs, etc.
39 41 This excludes HTML headers.
40 42
41 43 * ``--to latex``
44
42 45 Latex export. This generates ``NOTEBOOK_NAME.tex`` file,
43 46 ready for export. You can automatically run latex on it to generate a PDF
44 47 by adding ``--post PDF``.
45 48
46 49 - ``--template article`` (default)
50
47 51 Latex article, derived from Sphinx's howto template.
48 52
49 53 - ``--template book``
54
50 55 Latex book, derived from Sphinx's manual template.
51 56
52 57 - ``--template basic``
58
53 59 Very basic latex output - mainly meant as a starting point for custom templates.
54 60
55 61 * ``--to slides``
@@ -58,14 +64,23 b' The currently supported export formats are:'
58 64 It must be served by an HTTP server. The easiest way to get this is to add
59 65 ``--post serve`` on the command-line.
60 66
61 * ``--to markdown`` Simple markdown
67 * ``--to markdown``
68
69 Simple markdown output. Markdown cells are unaffected,
70 and code cells are placed in triple-backtick (``\`\`\```) blocks.
71
72 * ``--to rst``
62 73
63 * ``--to rst`` reStructuredText
74 Basic reStructuredText output. Useful as a starting point for embedding notebooks
75 in Sphinx docs.
64 76
65 * ``--to python`` Convert a notebook to an executable Python script.
77 * ``--to python``
78
79 Convert a notebook to an executable Python script.
66 80 This is the simplest way to get a Python script out of a notebook.
67 81 If there were any magics in the notebook, this may only be executable from
68 82 an IPython session.
83
69 84
70 85 The output file created by ``nbconvert`` will have the same base name as
71 86 the notebook and will be placed in the current working directory. Any
General Comments 0
You need to be logged in to leave comments. Login now