v0.3.0 nimib 0.3 compatibility + config + long time to document

[pietroppeter]

Details from changelog

• Improved docs and nim 2.0 compatibility (added to CI) (Improve docs for 0.3 (fix #51) + changelog + make it nim v2.0 compatible #56). other minor changes:
  • changes to commands:
    • clean command now only cleans the docs (outDir) folder, it does not clean srcFolder
    • update command now only forces update of assets (to create sources use init)
    • nimibook does not log anymore config and ToC every command it runs
  • updated CI to test on 1.6.x, devel, stable
  • improve nbook help (document dump and build options)
  • remove the rust file in assets/fonts
  • add as vendored the assets (css, font and js stuff)
• Parallel build fixes (Fix async and some other stuff #61)
  • Fixed parallel build so it uses the correct folder for saving log files.
  • The error messages are printed to terminal as well
  • Pass compiler flag -d:nimibParallelBuild=false to compile in serial.
  • Pass -d:nimibMaxProcesses=n to run at most n builds in parallel at a time (default is 10)
• The next-arrow is shown correctly on the second to last page. (Fix async and some other stuff #61)
• update to use nimib 0.3 and lots of maintenance (update nimibook to 0.3 + much needed maintenance WIP #50) including some breaking changes and some additional features:
  • fix usage of blocks context in document template update to reflect change in nimib 0.3
  • nimib.toml now supports configuration for the book (in a [nimibook] section),
    no need anymore to specify the configuration inside a nbook.nim file:
    • in particular now you can specify the name of folder for source and build of book, fixes Use different "book" directory #48
  • book.json is now published in docs folder and can work as a static api
  • removed default options from build command (they were "-d:release", "-f", "--verbosity:0", "--hints:off");
    build command now supports options that are passed to nim compiler
    • also now build fails at the end
  • init command now creates default sources for toc elements (in particular it creates a default nimib document that uses nimibook)
  • mustache templates are now in-memory partials, fixes templates should be used as in-memory partials #32
  • removed book source folder in toc (taken from config) and removed path field from Toc object
  • minor breaking changes:
    • templates folder changed to srcDir / templates
    • remove nbUseNimibook (use nbInit(theme = useNimibook))
    • newBookFromToc deprecated and replaced with initBookWithToc
    • various changes to Book type:
      • refactored Book.book_title into Book.title. Overrides previously existing Book.title which was supposed to be used for the Chapter title (not used)
      • removed book.path_to_root (it is a document/chapter thing)
  • default title for a page is now entry title/label, fix default title for a page should be entry title/label #46
  • rename and fix of draft entry, fix rename draft entry #44
    • also fix for init and build when entry is a draft (skip)
  • improved check command, fails after checking both sources and output and reports failures
  • general code refactoring. code structure is now documented in a readme.md inside src folder:
    • asset management moved to assets module and default assets moved in source
    • books and docs module removed and new modules builds, commands and configs added
  • renames examples to example_book and improved example
  • added unit tests, which are added to CI and we also test example book
• fix next/previous buttons when there is a draft chapter (see commit 428e482)
• add latex support using katex (activated with nb.useLatex as in standard nimib), see add latex support with katex #52
• made building happen async and in multiple process (see Made Building happen async and in multiple process #53):
  • this improves the speed of building nimibook
  • in case there is an error when building a specific entry a .log file is created next to the entry which contains the log of failure
• add deploy previews through netlify (add netlify deploy previews #55)
• improve documentation to track recent changes and add a changelog (Improve docs for 0.3 (fix #51) + changelog + make it nim v2.0 compatible #56)

What's Changed

• update nimibook to 0.3 + much needed maintenance WIP by @pietroppeter in update nimibook to 0.3 + much needed maintenance WIP #50
• add latex support with katex by @pietroppeter in add latex support with katex #52
• Made Building happen async and in multiple process by @beef331 in Made Building happen async and in multiple process #53
• add netlify deploy previews by @pietroppeter in add netlify deploy previews #55
• Fix async and some other stuff by @HugoGranstrom in Fix async and some other stuff #61
• Improve docs for 0.3 (fix document recent changes and release 0.3 #51) + changelog + make it nim v2.0 compatible by @pietroppeter in Improve docs for 0.3 (fix #51) + changelog + make it nim v2.0 compatible #56

New Contributors

• @beef331 made their first contribution in Made Building happen async and in multiple process #53

Full Changelog: v0.2.1...v0.3.0

---

This discussion was created from the release v0.3.0 nimib 0.3 compatibility + config + long time to document.

[pietroppeter]

long overdue release, took me more time than expected (like almost 1 year), just to clean up documentation...