Create a sweet-potato.config.js
in the root of the project same level as package.json
and export a config object.
module.exports = {
// Options
buildDirectory: "dist/",
sitemap: true,
sourceDirectory: "src",
breakpoints,
pagePlugins,
};
Type: string
Default: build
Specify the directory to which build the files to.
Type: string
Default: .
Specify the source directory.
Type: object
Localization configuration.
Default: locales
Name of the directory where the localization .yaml
files live.
Default: default
Name of the default locale and locale file.
🚨 Important to note that the default locale won't be placed inside a sub directory. For example, a fr.yaml
locale output will be /fr/index.html
whereas a default.yaml
output will be /index.html
.
Default: markdownContent
This is the name of the variable to which markdown content is supplied in the page object.
Type: object
Default: void
Defines a series of plugins to provide to the pug process. These functions are intended to be simple in/out methods that mutate, transform or query information based on inputs. They don't have a fixed signature, but can be provided either using the factory plugins provided by the sweet potato cooker (TO DO TBC) or your local installation.
const { imageSize } = require("@wethegit/sweet-potato-cooker/page-plugins");
...
pagePlugins = {
imageSize: imageSize(),
};
Type: function
Default: null
A function that will receive the file and environment as parameters and must return an object with valid node-sass options.
Example:
{
sassOptions: (isDev, file) => { return { // all options here } }
}
Type: string || boolean
Default: false
If set, will generate a sitemap.xml
during the production build.
If a string
is provided, will use it as the base url.
If true
, will use the PUBLIC_URL
value from the .env
file.
Type: object
Default: false
An object with key/value pair where the key is the name of the breakoint and the value is a valid media query.
These will be passed to pug
, scss
and js
files.
{
breakpoints: {
'medium-up': '(min-width: 768px)',
'large-up': '(min-width: 1024px)',
'medium-only': '(min-width: 768px) and (max-width: 1023px)'
}
}
Type: array
Default: false
Defines files/paths to be ignored during local development.
By default the following are ignored: