I’m excited to introduce a new web application that I’ve developed to streamline the creation of our Niagara Module documentation:
Example In Editor:
Example Exported & Built Into module-doc:
Key Features:
- Real-time Preview: As you create or edit your documentation, you’ll see a real-time preview of the final output, ensuring everything looks just right before exporting.
- Flexible Content: The generator supports the use of Markdown, HTML, and CSS, allowing you to format the documentation to meet our exact needs.
How to Use:
- Create Your Document: Use the intuitive form to add sections and blocks of content. You can include text, images, and custom styles as needed.
- Export Your Template: Once you’re satisfied with your document, be sure to export the template. This saves your progress and allows you to import it later if you need to make changes or updates.
- Pro Tip: After exporting, please upload your template to this WIKI topic. This will serve as a central repository for our documentation templates, ensuring everyone has access to the latest versions.
- Generate Documentation Files: After finalising your document, select “Generate Docs.” This will package the necessary files, which can then be placed directly in the
ddctCommunity-docmodule.
By using this tool, we can maintain consistent and professional documentation across our Niagara modules. It also simplifies the process of updating and improving our documentation as the project evolves.
Document Templates:
Change Log: changelog.json (2.8 KB)
Documentation Index Document: index.json (4.6 KB)
DdctCommunityService: DdctCommunityService.json (1.6 KB)