Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Towards the next release #323

Closed
1 of 18 tasks
tlienart opened this issue Dec 25, 2019 · 3 comments
Closed
1 of 18 tasks

Towards the next release #323

tlienart opened this issue Dec 25, 2019 · 3 comments

Comments

@tlienart
Copy link
Owner

tlienart commented Dec 25, 2019

Note: the base functions of Franklin are basically all there (serve, optimize, ...) and fairly stable, small things are changing which are more related to what it can parse + what it can do when parsing, these things are generally added as "patch releases" as they're unlikely to affect anyone apart from the one(s) who asked for that specific behaviour. In theory these should be minor releases but that would happen too often. So basically my philosophy is to do a minor release when "a few" such new things are added and I'm generally happy with the state of things.
All of this stuff is backward compatible in the sense that if your site worked before, it will work after. For a summary of 'important' changes see NEWS.md. The only place where a real break happened was in the 0.5 -> 0.6 transition. No such major transition is planned for the near future.

features

  • page snippets for a "recent posts" page (a la hugo etc) that parses katex properly for preview etc. Support for chronological posts.
  • taxonomy (tag pages) (PR: Taxonomy (second attempt) #481 ; minor release)
  • (brainstorm) consider merging of CSS into one if several are called in head.html by default (e.g. vela) --> can use purgecss hook for this
  • don't fail if page foot is not defined or empty.

Docs

  • on_write (example from wikunia)
  • globvar, locvar, pagevar + return nothing if unknown
  • lx_, hfun_and theutils.jl` file
  • taxonomy
  • multiple class with @@ so @@c1,c2 ... @@
  • custom content stuff with page vars (content_tag, content_div, content_id) see @findmyway 's PR and Custom content #521
  • clarify the internal thing with fd2html since people seem to use this more and more
  • can use regex to ignore folders (@Wikunia 's changes brought in Dev01 #522)
  • anchors brought in via \label have a class anchor (so that can offset a fixed navbar)
  • addition of a host keyword to serve (exposing an addition in liveserver @cserteGT3 )
  • removal of \underline see Remove \underline command to avoid clash with KaTeX #512 use \style instead
  • addition of {{isempty xx} and {{isnotempty xx}} blocks Add isempty html cond block #514

Code quality

@tlienart tlienart pinned this issue Dec 25, 2019
@tlienart tlienart changed the title Towards 0.5 Towards the next release Jan 17, 2020
This was referenced Apr 6, 2020
@findmyway
Copy link
Contributor

lx_, hfun_and the utils.jl` file

Can we also have a place to collect some common and inspiring code snippets?

For example, in the https://github.com/tlienart/franklindocs/blob/master/config.md there's a note command which is very useful. And @Wikunia also mentioned an interesting \showdiff command in his blog

@tlienart
Copy link
Owner Author

tlienart commented Jun 12, 2020

so many good ideas! (sorry I'm behind on all these docs things, it's hard to keep up 😱 )

@Wikunia
Copy link
Contributor

Wikunia commented Jun 12, 2020

I'm happy to help. Will work on something probably Monday maybe earlier. Would like to fill the currently empty Utils.jl page with basic explanation of lx and hfun and maybe an examples section.

@tlienart tlienart closed this as completed Sep 2, 2020
@tlienart tlienart unpinned this issue Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants