document recent changes and release 0.3

[pietroppeter]

document recent changes done in #50:

• [ ] add latex support with latex as in nimib
• [ ] document changes
  • [ ] refactoring and code structure (review)
  • [ ] templates
  • [ ] book.json
  • [ ] new nb/doc object in Book
  • [ ] blocks context in document.mustache
  • [ ] refactored Book.book_title into Book.title. Overrides previously existing Book.title which was supposed to be used for the Chapter title
  • [ ] cfg stuff
  • [ ] note that changes also fix https://github.com/pietroppeter/nimibook/issues/48 (you should be able to change name of book folder)
  • [ ] removed book.path_to_root (it is a document/chapter thing)
  • [ ] remove rootfolder in toc and path field in Toc
  • [ ] improved init
  • [ ] remove default parameters and allow to pass parameters to build
• [ ] after nimib 0.3 is released, change nimib dep and release this as 0.3

other improvements (next version):

• [ ] add nim code highlighting when starting from md file?
• [ ] improve clean? (maybe open an issue)
  • [ ] add a dry-run option
  • [ ] add keepSrc, keepOut, keepSrcDefaults, keepOutDefaults
• [ ] support part title in toc
• [ ] support SUMMARY.md
  • [ ] a default summary.md should be initialized
• [ ] provide nbook binary!
• [ ] dumped book.json (now a public api) should not contain cfgDir and it should only contain relative dirs
• [ ] quit failures for check and build should be only in cli? (useful for test?)

notes:

• cfgDir should be set as currentDir of nbook
• do I need also a srcDirRel and homeDirRel?
• I am removing srcDir from all entry paths
• srcDir and homeDir always assumed to be relative to cfgDir and always used as string. (maybe nimib should be like that)
• srcDir and homeDir should really be relative strings...
• decided indeed that srcDir and homeDir kept as string relative to cfgDir
• starting to call use outDir instead of homeDir more and more often... (should I change in nimib?)

[pietroppeter]

also:

• [ ] remove the rust file
• [ ] add as vendored the css and js stuff
• [ ] recent parallel build by beef