Skip to content
This repository
Browse code

moved some stuff into samples, expanding on a bit more of jodoc in th…

…e docs
  • Loading branch information...
commit 2d3e1082dc486f47a884c6aeaf8d8795946dfd02 1 parent 42b02a1
Daniel Freedman authored
2  README.mdown
Source Rendered
@@ -166,5 +166,5 @@ Defining a table of contents structure:
166 166
167 167 Building joDoc's documentation with joDoc:
168 168
169   - jodoc --output html -s --toc TOC_SAMPLE.md *.mdown && cp css/* html/ && cp index.html html/
  169 + jodoc --output html -s --toc samples/TOC_SAMPLE.mdown *.mdown && cp samples/css/* html/ && cp samples/index.html html/
170 170
40 TEMPLATE.mdown
Source Rendered
... ... @@ -0,0 +1,40 @@
  1 +HTML Template
  2 +=============
  3 +
  4 +joDoc allows for setting an HTML template to wrap around the text from the markdown blocks.
  5 +
  6 +Variables
  7 +---------
  8 +
  9 +Currently, the only variables supported in the HTML template are `$body` and `$title`.
  10 +
  11 +The `$body` tag will be replaced with the body of the HTML output, and `$title` will be replaced with whatever
  12 +
  13 +is given to the `--title` option for joDoc, or "JoDoc" by default.
  14 +
  15 +By default, a "non-terrible" template is used, linking to the css stylesheets in the `samples/css` folder.
  16 +
  17 +Examples
  18 +--------
  19 +
  20 +A simple example of a joDoc compatible template can be found in `samples/template.html`.
  21 +
  22 + <html><head><title>$title</title></head><body>$body</body></html>
  23 +
  24 +The default template of joDoc is a little more advanced, and depends on `doc.css` and `docbody.css`, which can be found in `samples/css/`.
  25 +
  26 + <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  27 + <html lang="en">
  28 + <head>
  29 + <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  30 + <title>$title</title>
  31 + <meta name="generator" content="joDoc">
  32 + <link rel="stylesheet" type="text/css" href="docbody.css">
  33 + <link rel="stylesheet" type="text/css" href="doc.css">
  34 + <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
  35 + <meta name="format-detection" content="false">
  36 + </head>
  37 + <body>
  38 + $body
  39 + </body>
  40 + </html>
5 TOC.mdown
Source Rendered
@@ -45,3 +45,8 @@ Munging
45 45
46 46 joDoc uses path name munging to root output HTML documents in a directory without accidentally overwriting files.
47 47 Because of this, it may be hard to embed direct links into the Table of Contents file. Everything works much better if you just leave it to the autolinker.
  48 +
  49 +Example
  50 +-------
  51 +
  52 +A good example of how to write a table of contents for joDoc can be found in `samples/TOC_SAMPLE.mdown`
3  TOC_SAMPLE.md → samples/TOC_SAMPLE.mdown
Source Rendered
@@ -13,7 +13,8 @@ joDoc Documentation
13 13
14 14 - {ABOUT.mdown}
15 15 - {README.mdown}
16   -- {css/}
  16 +- {TEMPLATE.mdown}
  17 +- {TOC.mdown}
17 18 - License
18 19
19 20 [Keyword Index](./_index.html)
0  css/doc.css → samples/css/doc.css
File renamed without changes
0  css/docbody.css → samples/css/docbody.css
File renamed without changes
0  index.html → samples/index.html
File renamed without changes
2  samples/template.html
... ... @@ -0,0 +1,2 @@
  1 +<!-- Just a really simple one line "sample" for a joDoc compatible template -->
  2 +<html><head><title>$title</title></head><body>$body</body></html>

0 comments on commit 2d3e108

Please sign in to comment.
Something went wrong with that request. Please try again.