Skip to content

v0.5.0

Compare
Choose a tag to compare
@julia-tagbot julia-tagbot released this 22 Jan 18:58
· 509 commits to master since this release
v0.5.0

This should be considered as the first 'proper' release of Franklin.jl after the renaming phase which was a bit hectic. See below for what has changed that you may want to consider when "migrating"; if you run into any subsequent issues, please open an issue, thanks a lot!

What to keep in mind when upgrading from JuDoc <= 0.4.3 to Franklin >= 0.5:

Here are the steps which I just followed for updating my own website, your case should be broadly similar:

  1. remove your current pub/ folder
  2. go to src/_css/ and find replace .jd-* into .franklin-* (to be precise .jd-content, and .jd-toc)
  3. go to src/_html_parts/ and replace any jd_* into fd_*, usually the only location where you may have to do this is page_foot where there may be a {{fill jd_mtime}} which would now need to be writte {{fill fd_mtime}} (time of last modification); in that same page_foot block, there may be the old ref to JuDoc which you should change to Franklin (thanks!)
  4. if you have a search with lunr you'll need to rebuild the index with lunr()
  5. test

Other noteworthy changes

  • the function to test markdown -> html conversion was named jd2html and is now fd2html, jd2html can still be used.
  • Franklin specific page variables are named fd_* (for instance fd_mtime for the modification time)
    any outstanding issues --> sorry and please open an issue here, thanks!