Skip to content

Releases: pietroppeter/nimibook

v0.3.1 - highlight code in markdown + fix doc render bug

24 Feb 20:18
1405553
Compare
Choose a tag to compare

fixes and improvements motivated by the excellent work by @PhilippMDoerner in adding nimibook documentation to @can-lehmann's excellent GUI library owl kettle can-lehmann/owlkettle#34

What's Changed

Full Changelog: v0.3.0...v0.3.1

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

19 Feb 20:47
797d0c1
Compare
Choose a tag to compare

Details from changelog

  • Improved docs and nim 2.0 compatibility (added to CI) (#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 (#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. (#61)
  • update to use nimib 0.3 and lots of maintenance (#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 #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 #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 #46
    • rename and fix of draft entry, fix #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 #52
  • made building happen async and in multiple process (see #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 (#55)
  • improve documentation to track recent changes and add a changelog (#56)

What's Changed

New Contributors

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

v0.2.1 bugfix path to root and path equality

07 Nov 18:44
81733b4
Compare
Choose a tag to compare

uses upstream fix of Nimib 0.2.1 and also fixes path equality comparison when generating active/previous/next in docs.nim

v0.2 - updated to Nimib 0.2

06 Nov 17:38
728af92
Compare
Choose a tag to compare
  • updated to Nimib 0.2
  • fix error with markdown files
  • build of a single page now works
  • updated docs