springheel.springheelinit module¶
Initialize a Springheel site.
-
async
springheel.springheelinit.
copyAssets
() → str¶ Copy assets from Springheel’s install directory to the current one.
- Returns
- str
The path to templates in Springheel’s install directory.
-
springheel.springheelinit.
getTemplatesPath
() → Tuple[str, str]¶ Find the install directory of Springheel and its templates.
- Returns
- raw_springheel_pathstr
The directory in which Springheel is installed.
- templates_pathstr
The path to the Springheel installation’s templates.
-
springheel.springheelinit.
initDir
(output_path: str, dir_name: str) → str¶ Create a subdirectory in the output if it doesn’t already exist.
- Parameters
- output_pathstr
Path to the output folder.
- dir_namestr
The name of the directory to create.
- Returns
- str
Path to the (new) directory.
-
springheel.springheelinit.
makeOutput
() → Tuple[str, str, str, str, str, str]¶ Create an output directory if it doesn’t already exist.
- Returns
- c_pathstr
Current (root) path.
- output_pathstr
Path to the output directory.
- pages_pathstr
Path to the pages directory in output.
- assets_pathstr
Path to the assets directory in output.
- arrows_pathstr
Path to the navigation arrow directory in output.
- socialbuttons_pathstr
Path to the social media icon directory in output.