Skip to content
bentayloruk edited this page Dec 18, 2012 · 4 revisions
  • A Cantos book is a sub-directory of _books that contains chapters (directories) that contain pages (text files).
  • A page must have a front matter value for title or toc-title to be included in the chapter links. *If title and toc-title both exist, we use toc-title.
  • Chapters and pages are ordered on the file system using number-wanging (patent pending).
  • The first page in the chapter is used as the chapter "home page".
  • Cantos builds a table of contents for the book in the same order as the chapter directories and files in each book. This TOC is available as toc in the meta for each page of the book.
  • Your can create multiple books.
  • Each book is output to a sub-folder of the generated site.
  • You specify the output book sub-folders by dot delimiting the book folder name (e.g. tech.don-syme.expert-fsharp -> tech/don-syme/expert-fsharp)

Example

Book source:

|-- _books  
    |-- tech.fsharp  
        |-- 0010-Introduction  
            |-- 0010-blah.md  
            |-- 0020-amazing.md  
        |-- 0020-TheEnd  
            |-- 0010-that-was.md  
            |-- 0020-quick.md  

Book Output

|-- _site  
    |-- tech  
        |-- fsharp  
            |-- Introduction  
                |-- amazing.html  
                |-- blah.html  
            |-- TheEnd  
                |-- quick.html  
                |-- that-was.html  
Clone this wiki locally