All notable changes to this project will be documented in this file.
- Clarified the project's pitch, function, and value in the readme and the manifest description.
- Re-implemented the
- Ensure reference documentation is actually being published to the public docs site.
- Published the module to the gallery.
- Moved the exportable variables into their own folder and out of the PSM1.
- Ensured the module will build the functions and variables into a single PSM1. The module files list is now a PSD1, a PSM1, and the folder(s) of plaster templates.
- Improved the readability and usability of the README.
- Updated the manifest in preparation for publishing to the gallery.
New-Documentfunction to scaffold out markdown document files in a project.
- Separated the tasks for building gitbook docs from the primary psake file in both the template and the project.
- Functions for adding (
Add-GitBookPlugin) and removing (
Remove-GitBookPlugin) GitBook plugins using PowerShell instead of manually editing your GitBook config files
- Narrative documentation for including media files in your documentation
- Functionality for including the
html5-videoGitBook plugin with your scaffolded GitBook documentation if you need to support audio/video files
- Functionality in both the template and project psake tasks for
Compileto copy the media folders of a project into the compiling folder if one is found
- Added option to specify copyright holder name in the plaster template. This is used for the copyright notice in the license.
- Added variables for the output site path and output pdf path to the psake file.
This ensures that the
Cleantask can run successfully.
- Ensured that the
.bookignorefiles are scaffolded into the
docsfolder instead of the project root. Those files weren't being copied into the compiling folder when building the documentation.
- Removed mention of the GitBook GUI editor, since it assumes that a project is a gitbook, not that a project is using gitbook for documentation. The gitbook editor will fail to load on this project layout.
- Updated the project documentation and template to be more clear about the types of documentation that are being scaffolded.
- Exported variable
$GitBookPlasterTemplatefrom the documentarian module. This will let users specify the variable instead of having to find the path to the template themselves every time they need to run it.
- Updated the readme to reflect using the variable and importing the module instead of saving off a fragile path in a variable, which they have previously needed to do every session.
- LivePreview task for both the project and the template, enabling users to get a live preview of their gitbook docs running locally.
- book.json for the project docs, which had been accidentally lost due to gitignore settings, which are now fixed.
- Made the compilation of documentation for gitbook safer in both the template and for the project itself.
The documentation will now compile into a temporary folder in the project root.
We've also added a
cleantask so that you can be sure you're always building your documentation without extra artifacts.
- We've modified the gitignore the project creates for this new layout.
- Ensured that the build scripts do not need to always run with elevated permissions. Added warnings to the psake task files for chocolatey package installations, ensuring that the tasks check for admin permissions and fail clearly if those permissions aren't present.
- Documentation scaffolding.
- Initial build for installing prerequisites, adding module to PSModule path, and compiling documentation (both as a site and as a PDF)