API Refrence 👏👏👏
When making a plugin, the functions you are using to connect with Rootbeer must take in a parameter (almost always sender) and the parameter will give you the things needed too create all the things you want.
Dictionary -- The parsed config file.
String. -- The site's title
Bool. -- Weather or not the posts will have pretty permalinks.
Bool. -- Weather or not the pages will have pretty permalinks.
String. -- The directory containing the content.
String. -- The directory to export all the rendered content.
String. -- The directory to put the blog posts when rendered.
String. -- The name of the theme being used.
String. -- The name of the directory containing the themes.
String. -- The format of the date for the content.
String. -- How to sort the pages
Bool. -- Weather to sort the pages reversed.
String. -- How to sort the posts.
Bool. -- Weather to sort the pages reversed.
List. -- A list of required metadata fields.
Dictionary -- The install and import names of extensions for the markdown parser.
List -- A list of all the content and their data. The content is stored in dictionaries.
List -- A list of the content types.
String. -- The site's base url.
Class <markdown.Markdown> -- The markdown parser.
Class <Jinja2.Environment> -- The Jinja2 environment.
String. -- The extension of the markdown files.
List. -- A list of all the pages.
List. -- A list of all the posts.
Dictionary -- The posts' data. Includes the file name, the metadata, the date, a readable date, the slug, the url, and the content.
Dictionary -- The site's config.
The RootbeerSSG class. Use this to access things in the Plugins API in the theme.
List -- A list of all the posts
List -- A list of all the pages.
Dictionary -- The site's config.
The RootbeerSSG class. Use this to access things in the Plugins API in the theme.
List -- A list of all the posts
Dictionary -- The site's config.
The RootbeerSSG class. Use this to access things in the Plugins API in the theme.
Filters will take an input and change it. You can use a filter like this:
{{ yo | <filter> }}Will parse Markdown syntax into HTML. Example:
{{ '# Very epicness' | mdify }} will turn into
<h1>Very epicness</h1>Will get the url of the relative path. Example:
{{ '../static/image/very_cool_img.png' | abs_url }}will turn into
https://example.com/static/image/very_cool_img.png