├── znai-maven-plugin-test ├── znai │ ├── index.md │ ├── lookup-paths │ ├── toc │ ├── doxygen.json │ ├── chapter │ │ └── doxygen-from-zip.md │ └── meta.json └── doxygen.zip ├── znai-docs ├── .gitignore ├── code-examples │ └── python │ │ ├── utils.py │ │ └── my_func_usage.py ├── znai │ ├── flow │ │ ├── data │ │ │ └── test.json │ │ ├── shortcuts.md │ │ ├── page-toc.md │ │ ├── support.md │ │ ├── shortcuts.csv │ │ └── footer.md │ ├── snippets │ │ ├── cpp-surroundedby-scopes.cpp │ │ ├── urlsample.txt │ │ ├── markdown-dir │ │ │ ├── inlined.md │ │ │ ├── inlined-alternative.md │ │ │ ├── getting-started-step-external.md │ │ │ ├── md-to-include.md │ │ │ └── markdown-with-markers.md │ │ ├── lines-to-highlight.txt │ │ ├── ocaml │ │ │ ├── api.mli │ │ │ ├── api.ml │ │ │ ├── model.mli │ │ │ └── domain.mli │ │ ├── simple.json │ │ ├── cli │ │ │ ├── command.txt │ │ │ └── file-path-of-asserted-lines.txt │ │ ├── incomplete.json │ │ ├── replace-all-group.txt │ │ ├── code-reference-inlined-code-example.md │ │ ├── book-store-paths.json │ │ ├── trader.json │ │ ├── Hello.sc │ │ ├── simple.c │ │ ├── schema-notes.csv │ │ ├── file-name.js │ │ ├── jupyter │ │ │ ├── notebook.png │ │ │ └── games.csv │ │ ├── custom.dsl │ │ ├── references │ │ │ ├── json-references-demo.csv │ │ │ ├── references-demo.csv │ │ │ ├── references-demo.json │ │ │ └── javadoc-references-demo.csv │ │ ├── faq-collection │ │ │ ├── 2022-07-15-preview.md │ │ │ └── 2022-07-14-install.md │ │ ├── schema-notes.json │ │ ├── callouts │ │ │ ├── file-name-with-comments.js │ │ │ └── file-name-with-multiline-comments.py │ │ ├── with-nested-if.js │ │ ├── WideCode.java │ │ ├── MyClass.java │ │ ├── simple.cpp │ │ ├── typescript │ │ │ └── demo.tsx │ │ ├── global-references.js │ │ ├── with-multiple-if.js │ │ └── python-examples.py │ ├── custom.html │ ├── tracking.html │ ├── doxygen.json │ ├── demo-run-book │ │ ├── release-notes.md │ │ └── release-notes │ │ │ ├── 20170110.md │ │ │ ├── 20170123.md │ │ │ └── 20170127.md │ ├── visuals │ │ ├── data.csv │ │ ├── graphviz.dot │ │ ├── charts │ │ │ ├── genres.csv │ │ │ ├── time-series.csv │ │ │ ├── competitors.csv │ │ │ ├── daily-genres.csv │ │ │ └── game-activities.csv │ │ ├── idea.png │ │ ├── books.jpg │ │ ├── castle.jpg │ │ ├── screenshot1.png │ │ ├── small-book.png │ │ ├── idea-cropped.png │ │ ├── regular-image.png │ │ ├── word-toolbar.jpg │ │ ├── custom-components.md │ │ ├── editor-overview.png │ │ ├── testingisdocumenting.csv │ │ ├── flow-diagrams │ │ │ ├── graph-using-lib.json │ │ │ ├── nodes-lib-a.json │ │ │ ├── nodes-lib-b.json │ │ │ └── multiline-dag.json │ │ ├── testingisdocumenting.png │ │ ├── editor-overview.json │ │ ├── asciinema.md │ │ ├── text-badge.md │ │ ├── diamond.svg │ │ └── gantt.plantuml │ ├── release-notes │ │ ├── 1.54 │ │ │ ├── doc-2021-10-22-example-section.md │ │ │ ├── add-2021-11-01-text-badge.md │ │ │ ├── add-2021-11-14-heading-style.md │ │ │ ├── add-2021-09-17-tabs-validation.md │ │ │ ├── add-2021-10-10-upload-zip.md │ │ │ ├── add-2021-11-04-text-badge-header.md │ │ │ ├── add-2021-09-28-graphviz-include-plugin.md │ │ │ ├── add-2021-11-07-doxygen-comment.md │ │ │ ├── _fix-2021-11-22-enterprise-groups-authz.md │ │ │ ├── add-2021-09-19-plugin-error-context.md │ │ │ ├── add-2021-11-10-doxygen-member-signature.md │ │ │ ├── _fix-2021-10-30-note-icons-alignment.md │ │ │ ├── add-2021-11-17-doxygen-member-args-selection.md │ │ │ ├── add-2021-11-14-javadoc-field-ambig.md │ │ │ ├── add-2021-11-17-doxygen-all-signatures-at-once.md │ │ │ ├── add-2021-11-16-doxygen-compound.md │ │ │ ├── add-2021-11-22-doxygen-ignore-template-param.md │ │ │ ├── add-2021-09-25-plugin-params-parse-error-context.md │ │ │ ├── add-2021-10-20-comments-type-remove.md │ │ │ ├── add-2021-09-17-pydoc-assignment-parse-fix.md │ │ │ └── add-2021-11-08-doxygen-func-params.md │ │ ├── 1.60 │ │ │ ├── add-2022-09-11-card.md │ │ │ ├── add-2022-08-30-image-anchor.md │ │ │ ├── add-2022-08-30-table-anchor.md │ │ │ ├── add-2022-09-08-table-no-gap.md │ │ │ ├── add-2022-09-08-table-collapsed.md │ │ │ ├── fix-2022-09-06-image-mobile-fit.md │ │ │ ├── add-2022-08-31-table-formal-params.md │ │ │ ├── add-2022-09-01-java-anchor-id.md │ │ │ ├── add-2022-09-07-image-mobile-padding.md │ │ │ ├── add-2022-09-08-api-params-gap.md │ │ │ ├── add-2022-09-11-third-column.md │ │ │ ├── doc-2022-08-23-local-build.md │ │ │ ├── add-2022-09-01-python-anchor.md │ │ │ ├── add-2022-08-23-attention-sign-block.md │ │ │ ├── add-2022-09-03-mobile-only-image.md │ │ │ ├── add-2022-09-01-compact-rename.md │ │ │ ├── add-2022-09-08-highlight-all-matches.md │ │ │ ├── add-2022-08-24-external-code-snippet-anchor.md │ │ │ ├── add-2022-09-07-image-collapse-no-gap.md │ │ │ └── add-2022-09-09-auto-anchor-from-title.md │ │ ├── 1.52 │ │ │ ├── add-2021-07-15-win-cmd.md │ │ │ ├── add-2021-08-19-scala-highlight.md │ │ │ ├── add-2021-08-11-page-toc.md │ │ │ ├── add-2021-09-05-log-rotation-enterprise.md │ │ │ ├── add-2021-07-24-table-wide-mode.md │ │ │ ├── add-2021-07-21-table-percentage-width.md │ │ │ ├── add-2021-07-22-table-column-min-width.md │ │ │ ├── add-2021-08-16-table-highlight-row.md │ │ │ ├── _fix-2021-08-03-table-title-scroll.md │ │ │ ├── add-2021-08-14-py-doc-params-dash.md │ │ │ ├── add-2021-07-12-py-vars.md │ │ │ ├── add-2021-09-04-api-params-style-tweaks.md │ │ │ ├── add-2021-08-24-py-doc-params-optional-type.md │ │ │ └── add-2021-08-25-py-doc-exclude-params-from-desc.md │ │ ├── 1.72 │ │ │ ├── add-2024-10-23-html-block.md │ │ │ ├── add-2024-11-03-experimental-top-header.md │ │ │ ├── add-2024-10-01-search-hotkey.md │ │ │ ├── add-2024-10-19-initial-footnotes.md │ │ │ ├── add-2024-11-02-graphviz-align.md │ │ │ ├── add-2024-10-05-custom-anchor-id.md │ │ │ ├── add-2024-10-05-dollar-latex-inline.md │ │ │ ├── add-2024-10-07-dollar-latex-block.md │ │ │ ├── add-2024-11-02-heading-link-support.md │ │ │ ├── add-2024-11-02-graphviz-color-fix.md │ │ │ ├── add-2024-11-03-snippet-strip-indent.md │ │ │ └── add-2024-10-02-iframe-max-height.md │ │ ├── 1.64 │ │ │ ├── add-2023-09-18-ocaml-highlight.md │ │ │ ├── add-2023-07-02-json-callouts.md │ │ │ ├── add-2023-09-07-upload-txt.md │ │ │ ├── add-2023-06-27-java-17.md │ │ │ ├── add-2023-03-01-plugin-params-rename.md │ │ │ ├── add-2023-03-09-json-highlight-keys.md │ │ │ ├── add-2023-07-03-json-callouts-file.md │ │ │ ├── add-2023-07-21-snippet-anchor-no-file.md │ │ │ ├── doc-2023-09-10-testing-page-tweaks.md │ │ │ ├── fix-2023-09-04-links-from-index.md │ │ │ ├── add-2023-07-25-surrounded-by-keep.md │ │ │ ├── add-2023-08-17-highlights-region-single.md │ │ │ ├── add-2023-08-24-yellow-ansi-tweaks.md │ │ │ ├── doc-2023-08-21-snippets-highlight-page.md │ │ │ ├── fix-2023-02-28-code-constant-color.md │ │ │ ├── fix-2023-09-05-footer-images.md │ │ │ ├── add-2023-08-11-relative-links.md │ │ │ ├── add-2023-08-19-highlights-region-scope.md │ │ │ ├── fix-2023-02-28-presentation-bullet-list-grid.md │ │ │ ├── add-2023-08-15-highlights-next-prev.md │ │ │ ├── add-2023-09-18-preview-toc-items-outside.md │ │ │ ├── add-2023-09-24-iframe-fit.md │ │ │ ├── add-2023-09-19-md-preprocessor.md │ │ │ ├── add-2023-09-12-surrounded-by-message.md │ │ │ ├── add-2023-03-10-json-paths-param-rename.md │ │ │ └── fix-2023-08-30-preview-sub-sections.md │ │ ├── 1.76 │ │ │ ├── add-2025-05-19-em-dash.md │ │ │ ├── fix-2025-05-19-search-implicit-section.md │ │ │ ├── add-2025-05-19-hide-presentation-trigger.md │ │ │ ├── add-2025-05-19-new-local-search-engine.md │ │ │ ├── add-2025-05-19-style-tweaks.md │ │ │ └── add-2025-05-10-reference-markdowns-without-path-format-restriction.md │ │ ├── 1.50 │ │ │ ├── add-2021-05-03-more-permissive-json.md │ │ │ ├── add-2021-05-11-xml-path-validation.md │ │ │ ├── add-2021-05-21-footer-change-detect.md │ │ │ ├── _fix-2021-05-16-back-button.md │ │ │ ├── add-2021-05-12-json-path-validation.md │ │ │ ├── _fix-2021-05-10-xml-align-render.md │ │ │ ├── add-2021-05-22-click-to-zoom-img.md │ │ │ ├── add-2021-05-03-enterprise-validate-path.md │ │ │ ├── add-2021-05-03-port-info-on-busy-port.md │ │ │ ├── add-2021-05-22-scale-param-img.md │ │ │ ├── _fix-2021-05-18-meta-merge.md │ │ │ ├── add-2021-05-29-cli-params-highlight.md │ │ │ ├── add-2021-06-15-python-function.md │ │ │ ├── doc-2021-05-23-getting-started-clarify.md │ │ │ ├── add-2021-06-16-img-annotation-badge-transparent.md │ │ │ ├── _fix-2021-06-06-columns-snippet.md │ │ │ ├── add-2021-05-16-surrounded-by.md │ │ │ ├── add-2021-05-09-snippet-extra-validation.md │ │ │ ├── add-2021-05-03-include-python-doc.md │ │ │ ├── add-2021-05-16-inlined-snippet-validation.md │ │ │ └── _fix-2021-05-31-page-change-jump.md │ │ ├── 1.71 │ │ │ ├── doc-2024-09-03-styling.md │ │ │ ├── add-2024-08-28-default-tabs.md │ │ │ ├── add-2024-07-09-code-snippet-better-search.md │ │ │ ├── add-2024-09-07-search-highlight-improvement.md │ │ │ ├── add-2024-09-10-search-wildcard.md │ │ │ ├── add-2024-08-21-latex-inline-margin-tweaks.md │ │ │ ├── add-2024-09-17-search-snippets-high-score.md │ │ │ └── add-2024-09-24-additional-anchor-ids.md │ │ ├── 1.75 │ │ │ ├── fix-2025-04-26-slf4j-warning.md │ │ │ ├── add-2025-04-28-readmore-plugin.md │ │ │ ├── add-2025-05-03-simplified-server-page-content-id.md │ │ │ ├── fix-2025-04-27-markdown-image-fit-true.md │ │ │ ├── fix-2025-04-26-preview-server-kill.md │ │ │ ├── fix-2025-05-03-preview-same-file-name-clash.md │ │ │ ├── add-2025-04-27-include-markdown-preprocessor.md │ │ │ ├── add-2025-05-04-markdown-toc-custom-path.md │ │ │ └── add-2025-05-04-asciinema-improvements.md │ │ ├── 1.79 │ │ │ ├── add-2025-09-07-slack-env-var.md │ │ │ ├── add-2025-08-31-ask-in-slack-bubble-toggle.md │ │ │ ├── add-2025-09-07-slack-persisted-questions.md │ │ │ ├── fix-2025-08-31-ask-in-slack-bubble-height.md │ │ │ ├── add-2025-08-31-index-pages-for-chapters.md │ │ │ ├── add-2025-09-07-jupyter-table-style-tweaks.md │ │ │ └── fix-2025-08-31-jupyter-include-section-fix.md │ │ ├── 1.82 │ │ │ ├── doc-2025-11-02-jupyter.md │ │ │ ├── add-2025-11-02-jupyter-example.md │ │ │ ├── add-2025-11-02-add-page-sections-to-llm-txt.md │ │ │ ├── add-2025-11-02-search-entries-xml.md │ │ │ └── add-2025-11-02-slack-offline-indicator.md │ │ ├── 1.55 │ │ │ ├── _fix-2021-11-30-win-cmd.md │ │ │ ├── add-2021-11-25-cli-fence.md │ │ │ ├── _fix-2021-12-02-snippet-highlight-regression.md │ │ │ ├── add-2021-11-12-selection-dark-theme.md │ │ │ ├── add-2021-12-27-replace.md │ │ │ ├── _fix-2021-12-24-ansi-background-fix.md │ │ │ ├── doc-2021-12-01-what-is-this-revamp.md │ │ │ ├── doc-2021-12-22-snippet-manipulation.md │ │ │ ├── add-2021-12-31-section-title-badge.md │ │ │ ├── add-2021-12-30-doxygen-args-normalize.md │ │ │ ├── add-2021-12-22-surrounded-by-multiple.md │ │ │ └── add-2021-12-31-badge-colors.md │ │ ├── 1.57 │ │ │ ├── fix-2022-05-20-toc-selected-padding.md │ │ │ ├── add-2022-05-14-chart-legend.md │ │ │ ├── add-2022-05-13-bar-chart-stack.md │ │ │ ├── add-2022-05-18-charts-fence.md │ │ │ ├── add-2022-05-18-charts-wide-mode.md │ │ │ ├── add-2022-05-14-chart-dark-theme.md │ │ │ ├── add-2022-05-24-doxygen-from-zip.md │ │ │ ├── fix-2022-05-09-fix-markdown-snippet-render.md │ │ │ ├── fix-2022-05-16-latex-render.md │ │ │ ├── add-2022-05-12-multi-bar-chart.md │ │ │ ├── add-2022-05-13-bar-chart-horizontal.md │ │ │ ├── fix-2022-04-29-fix-search-preview-height.md │ │ │ ├── add-2022-05-04-landing-same-page-docs.md │ │ │ ├── add-2022-05-13-pie-echart.md │ │ │ ├── add-2022-05-13-line-echart.md │ │ │ ├── add-2022-05-14-remove-chart-plugin.md │ │ │ ├── add-2022-05-15-chart-presentation.md │ │ │ ├── add-2022-05-16-external-images.md │ │ │ ├── add-2022-05-18-steps-bullets-align.md │ │ │ ├── fix-2022-05-18-table-text-selection-preview.md │ │ │ ├── add-2022-05-20-api-params-validation.md │ │ │ ├── add-2022-05-23-charts-pie-presentation.md │ │ │ ├── add-2022-05-24-charts-bar-presentation.md │ │ │ ├── add-2022-05-25-lookup-paths-cli-rework.md │ │ │ ├── fix-2022-05-10-code-snippet-columns.md │ │ │ ├── add-2022-04-20-surrounded-by-null-separator.md │ │ │ ├── fix-2022-05-18-read-more-preview.md │ │ │ ├── add-2022-05-23-zip-jar-lookup-path.md │ │ │ ├── add-2022-05-08-wrap-code.md │ │ │ ├── add-2022-04-20-java-groovy-entry-separator.md │ │ │ ├── add-2022-05-20-api-params-long-param-names-wrap.md │ │ │ └── add-2022-05-24-charts-breakpoint-conversion-validation.md │ │ ├── 1.58 │ │ │ ├── add-2022-06-20-support-title.md │ │ │ ├── fix-2022-06-22-json-order.md │ │ │ ├── add-2022-05-30-version-cli-param.md │ │ │ ├── add-2022-06-13-json-fence-plugin.md │ │ │ ├── add-2022-06-21-image-title.md │ │ │ ├── doc-2022-07-03-template-rework.md │ │ │ ├── doc-2022-07-16-cpp-chapter.md │ │ │ ├── fix-2022-06-21-empty-column.md │ │ │ ├── fix-2022-06-22-ipad-search.md │ │ │ ├── add-2022-07-14-python-cache.md │ │ │ ├── add-2022-07-08-makdown-snippet-code-color.md │ │ │ ├── doc-2022-07-15-java-chapter.md │ │ │ ├── fix-2022-06-20-image-border.md │ │ │ ├── fix-2022-07-12-python-decorator-highlight.md │ │ │ ├── add-2022-07-02-mermaid-wide.md │ │ │ ├── doc-2022-06-20-json-webtau-example.md │ │ │ ├── doc-2022-06-21-columns.md │ │ │ ├── doc-2022-07-15-python-chapter.md │ │ │ ├── fix-2022-06-04-ipad-layout-fix.md │ │ │ ├── fix-2022-07-08-python-multiline-color.md │ │ │ ├── add-2022-06-07-java-plugins-params-formalization.md │ │ │ ├── doc-2022-07-02-icons-table-example.md │ │ │ ├── fix-2022-07-08-python-multi-line.md │ │ │ ├── fix-2022-07-16-doxygen-method-link-color.md │ │ │ ├── add-2022-06-05-json-code-references.md │ │ │ ├── add-2022-06-20-image-formal-parameters.md │ │ │ ├── add-2022-06-22-api-params-title.md │ │ │ ├── add-2022-06-22-api-params-wide.md │ │ │ ├── add-2022-06-22-image-zoom-color.md │ │ │ ├── add-2022-07-02-mermaid-include.md │ │ │ ├── doc-2022-07-20-synergy-test.md │ │ │ ├── fix-2022-06-22-image-zoom-scale.md │ │ │ ├── add-2022-05-30-wrong-cli-param-simpler-output.md │ │ │ ├── add-2022-06-04-json-path-highlight-color.md │ │ │ ├── add-2022-06-23-tooltip-comment-bullets.md │ │ │ ├── add-2022-07-02-graphviz-fence.md │ │ │ ├── add-2022-07-11-heading-style-in-menu.md │ │ │ ├── doc-2022-06-22-image-pixel-ratio.md │ │ │ ├── doc-2022-07-28-incomplete-json.md │ │ │ ├── fix-2022-06-22-column-starts-with-link.md │ │ │ ├── add-2022-06-20-json-collapsed-paths-validation.md │ │ │ ├── add-2022-06-22-api-params-params.md │ │ │ ├── add-2022-07-01-mermaid-dark-theme.md │ │ │ ├── add-2022-07-16-image-annotation-csv.md │ │ │ ├── add-2022-07-16-markdowns-sort.md │ │ │ ├── add-2022-07-18-image-annot-json-color.md │ │ │ ├── add-2022-07-01-readmore-collapse.md │ │ │ ├── add-2022-07-12-python-doc-returns.md │ │ │ ├── doc-2022-07-08-lookup-paths-classpath-fix.md │ │ │ ├── add-2022-06-15-badges-fence-auto-color.md │ │ │ ├── add-2022-07-04-python-doc-type-hints.md │ │ │ ├── add-2022-07-14-image-arrow-rect-tooltip.md │ │ │ ├── doc-2022-06-20-what-is-this.md │ │ │ ├── add-2022-07-14-image-arrow-rect.md │ │ │ ├── fix-2022-06-16-image-scale-annotations.md │ │ │ ├── fix-2022-07-19-maven-delete-on-exit.md │ │ │ ├── add-2022-06-30-image-annotation-coordinates.md │ │ │ ├── add-2022-06-27-image-annotation-arrow-style.md │ │ │ ├── add-2022-07-10-python-class-def.md │ │ │ ├── add-2022-06-11-json-params-and-auto-title.md │ │ │ ├── add-2022-06-24-image-annotation-bullet-list.md │ │ │ ├── add-2022-07-05-remove-global-ref-js.md │ │ │ ├── add-2022-07-12-python-class-properties.md │ │ │ ├── add-2022-06-05-plugins-params-formalization.md │ │ │ └── add-2022-07-08-python-method-def.md │ │ ├── 1.80 │ │ │ ├── add-2025-09-09-highlight-svg.md │ │ │ ├── add-2025-09-14-highlight-inside-spoiler.md │ │ │ ├── fix-2025-09-13-focus-page-content-on-load.md │ │ │ ├── fix-2025-09-08-ask-in-slack-index-page.md │ │ │ ├── fix-2025-09-08-ask-in-slack-trailing-slash.md │ │ │ └── add-2025-09-09-highlight-inside-codesnippet-readmore.md │ │ ├── 1.84 │ │ │ ├── add-2025-12-10-mermaid-upgrade.md │ │ │ ├── add-2025-11-23-search-highlights-improvements.md │ │ │ ├── add-2025-12-07-tracking-http-end-point.md │ │ │ ├── fix-2025-11-23-search-highlights-improvements.md │ │ │ └── fix-2025-12-06-ocaml-comments-fix-indentation.md │ │ ├── 1.56 │ │ │ ├── add-2022-01-07-plugins-stats.md │ │ │ ├── add-2022-02-25-optional-index.md │ │ │ ├── add-2022-02-06-open-api-loop.md │ │ │ ├── add-2022-01-08-plugins-params-stats.md │ │ │ ├── fix-2022-02-20-search-highlight-across.md │ │ │ ├── add-2022-02-15-validate-external-links.md │ │ │ ├── add-2022-03-27-partial-markdown.md │ │ │ ├── fix-2022-02-01-search-special-chars.md │ │ │ ├── add-2022-02-09-fence-image.md │ │ │ ├── fix-2022-02-01-search-popup-size.md │ │ │ ├── fix-2022-02-08-java-multiline-comment.md │ │ │ ├── add-2022-03-22-groovy-multiple-body-only.md │ │ │ ├── add-2022-03-21-java-multiple-body-only.md │ │ │ └── add-2022-03-23-java-groovy-multiple-body-separator.md │ │ ├── 1.59 │ │ │ ├── add-2022-08-13-open-api3.md │ │ │ ├── add-2022-07-25-snippet-class-color.md │ │ │ ├── add-2022-08-15-charts-time.md │ │ │ ├── add-2022-07-25-chapter-title-override.md │ │ │ ├── add-2022-07-27-standard-image-title.md │ │ │ ├── fix-2022-07-22-image-zoom-vertical-scroll.md │ │ │ ├── add-2022-08-05-api-params-expand-when-only.md │ │ │ ├── fix-2022-07-24-image-horizontal-scroll-cut.md │ │ │ ├── add-2022-08-10-snippet-compact.md │ │ │ ├── add-2022-08-03-api-params-collapse.md │ │ │ └── add-2022-08-10-snippet-collapse.md │ │ ├── 1.77 │ │ │ ├── add-2025-07-06-initial-llm.md │ │ │ ├── add-2025-07-07-ocaml-comments.md │ │ │ └── add-2025-07-04-footnote-force-index.md │ │ ├── 1.83 │ │ │ ├── fix-2025-11-09-llm-txt-fix-links.md │ │ │ ├── add-2025-11-09-search-entries-extra-fields.md │ │ │ ├── add-2025-11-08-expose-llm-txt.md │ │ │ ├── fix-2025-11-08-add-new-file-toc.md │ │ │ ├── fix-2025-11-16-llm-text-selection-triple-click.md │ │ │ └── add-2025-11-12-search-highlight.md │ │ ├── 1.62 │ │ │ ├── add-2022-10-28-enum-formal-params.md │ │ │ ├── add-2022-10-30-json-anchorid.md │ │ │ ├── add-2022-11-02-card-table.md │ │ │ ├── add-2022-11-26-report-unknown-inlined-code-plugin.md │ │ │ ├── doc-2022-11-29-open-api-prop-title.md │ │ │ ├── add-2022-11-21-inline-markdown.md │ │ │ ├── add-2022-11-01-table-wide-title-center.md │ │ │ ├── add-2022-12-01-javadoc-markdown.md │ │ │ ├── add-2022-12-09-plugin-defaults.md │ │ │ ├── add-2022-12-10-plugin-page-local-defaults.md │ │ │ ├── fix-2022-11-25-graphviz-multiline-fix.md │ │ │ ├── add-2022-11-29-cli-output-and-anchor.md │ │ │ └── doc-2022-11-26-code-reference-clarify.md │ │ ├── 1.66 │ │ │ ├── add-2023-12-06-iframe-title.md │ │ │ ├── add-2023-11-16-iframe-mobile-gap.md │ │ │ ├── add-2023-12-15-charts-columns.md │ │ │ ├── add-2023-11-17-iframe-presentation.md │ │ │ ├── add-2023-12-07-iframe-auto-reload.md │ │ │ ├── fix-2023-12-14-console-output-leading-spaces.md │ │ │ ├── add-2023-12-31-snippet-no-gap-separator.md │ │ │ └── fix-2023-11-21-include-plugin-parser.md │ │ ├── 1.68 │ │ │ ├── add-2024-03-07-doxygen-note.md │ │ │ ├── add-2024-02-28-doxygen-noexcept.md │ │ │ ├── add-2024-02-29-doxygen-decltype.md │ │ │ ├── add-2024-04-02-toc-title-override.md │ │ │ ├── add-2024-03-26-specify-extension-in-toc.md │ │ │ ├── add-2024-03-19-empty-doc-id.md │ │ │ ├── add-2024-03-14-doxygen-member-presentation.md │ │ │ ├── fix-2024-04-04-json-presentation-mode-fix.md │ │ │ ├── add-2024-03-27-api-params-presentation.md │ │ │ ├── add-2024-02-12-keep-start-end-single-lines.md │ │ │ ├── add-2024-02-12-highlight-region-by-scope-multistart.md │ │ │ └── add-2024-02-14-start-end-line-empty-validation.md │ │ ├── 1.74 │ │ │ ├── add-2025-03-02-asciinema.md │ │ │ ├── add-2025-02-25-ocaml-inline-comments.md │ │ │ ├── add-2025-04-22-support-for-relative-url-with-dot.md │ │ │ ├── add-2025-04-23-markdown-image-fit-true.md │ │ │ ├── add-2025-02-25-preview-reduce-output-details.md │ │ │ ├── add-2025-04-23-toc-links-in-every-page.md │ │ │ ├── add-2025-04-15-redirect-use-absolute-url.md │ │ │ ├── add-2025-03-15-preview-reuse-server.md │ │ │ └── fix-2025-04-23-doc-id-multiple-parts-click-root.md │ │ ├── 1.81 │ │ │ ├── add-2025-10-19-scaffold-custom-content.md │ │ │ ├── add-2025-10-19-page-redirects.md │ │ │ ├── add-2025-10-12-search-for-plugins.md │ │ │ ├── add-2025-10-19-cli-title-override.md │ │ │ ├── add-2025-10-20-llm-page-urls.md │ │ │ ├── fix-2025-10-19-global-search-entries-comma.md │ │ │ ├── add-2025-10-07-command-line-args-revamp.md │ │ │ └── add-2025-10-19-jupyter-improved-render.md │ │ ├── 1.73 │ │ │ ├── add-2024-11-10-footnote-style-tweaks.md │ │ │ ├── add-2024-11-09-preprocessor-new-line-support.md │ │ │ ├── fix-2024-11-08-search-custom-anchor.md │ │ │ ├── fix-2024-11-09-ignore-html-comment.md │ │ │ ├── add-2024-11-08-top-header-current-toc.md │ │ │ ├── add-2024-11-09-footnote-preview-fixed-width.md │ │ │ ├── add-2024-11-09-graphviz-colors.md │ │ │ ├── fix-2024-11-08-section-tracking-custom-anchor.md │ │ │ ├── fix-2024-11-09-search-file-gen-ansi-cleaner.md │ │ │ ├── add-2024-11-10-footnote-normalize-labels.md │ │ │ └── add-2024-11-09-header-tweaks.md │ │ ├── 1.59.1 │ │ │ ├── add-2022-08-21-plant-uml-bump.md │ │ │ ├── add-2022-08-22-toc-panel-tooltip.md │ │ │ ├── fix-2022-08-22-chapter-name-render-fix.md │ │ │ ├── fix-2022-08-21-api-params-empty-names.md │ │ │ ├── add-2022-08-22-attention-sign-tip.md │ │ │ ├── add-2022-08-22-sql-cypher-graphql-syntax.md │ │ │ ├── fix-2022-08-22-api-params-fence-inside-tabs.md │ │ │ └── fix-2022-08-22-java-body-only-single-overload.md │ │ ├── 1.61.1 │ │ │ ├── fix-2022-10-04-null-pointer-create-url.md │ │ │ ├── fix-2022-10-04-more-stack-trace.md │ │ │ └── add-2022-10-05-image-annotation-report-outside.md │ │ ├── 1.61 │ │ │ ├── add-2022-09-28-table-filter-regexp.md │ │ │ ├── doc-2022-09-29-table-multiline.md │ │ │ ├── fix-2022-09-30-index-title.md │ │ │ ├── add-2022-09-23-table-wide-gap.md │ │ │ ├── fix-2022-09-27-java-anchor-id.md │ │ │ └── fix-2022-09-25-index-local-ref.md │ │ ├── 1.63 │ │ │ ├── add-2022-12-19-cli-output-wide.md │ │ │ ├── fix-2023-02-06-json-null.md │ │ │ ├── add-2023-01-06-code-reference-json.md │ │ │ ├── add-2023-01-09-json-enclose-in-object.md │ │ │ ├── fix-2023-02-21-image-svg-null-pointer.md │ │ │ ├── fix-2023-02-08-table-params-conflict.md │ │ │ ├── add-2023-01-05-cli-command-visuals.md │ │ │ ├── fix-2022-12-25-snippet-last-api-parameters-gap.md │ │ │ ├── add-2023-01-16-openapi-summary-validation-auto-section.md │ │ │ ├── add-2022-12-23-exclude-start-end-separately.md │ │ │ ├── add-2023-01-01-exclude-include-contains.md │ │ │ ├── add-2023-01-10-cli-output-highlight-remove-ansi.md │ │ │ ├── add-2023-01-20-surrounded-by-validation.md │ │ │ ├── add-2023-01-22-code-reference-fix.md │ │ │ ├── fix-2022-12-26-image-pusling-badge.md │ │ │ ├── add-2023-01-22-plugin-params-validation-tweaks.md │ │ │ ├── add-2022-12-22-identifier-multiple-paths.md │ │ │ ├── add-2023-01-02-trim-empty-lines-no-params.md │ │ │ └── add-2022-12-21-no-gap-tweaks.md │ │ ├── 1.70 │ │ │ ├── fix-2024-05-29-view-on-index.md │ │ │ ├── add-2024-06-06-upload-resource-locator.md │ │ │ └── fix-2024-06-04-doxygen-members-empty-declname.md │ │ ├── 1.65 │ │ │ ├── add-2023-11-06-plantuml-bsd.md │ │ │ ├── fix-2023-09-25-iframe-restore-focus.md │ │ │ ├── add-2023-10-05-surrounded-by-scope.md │ │ │ ├── add-2023-09-25-iframe-index-html.md │ │ │ ├── add-2023-09-27-iframe-properties-override.md │ │ │ └── add-2023-10-07-surrounded-by-multichars-scope.md │ │ ├── 1.78.1 │ │ │ ├── fix-2025-08-26-remove-ask-in-slack-bubble.md │ │ │ ├── fix-2025-08-26-ask-slack-url-with-slash.md │ │ │ └── fix-2025-08-26-remove-ask-in-slack-content-type.md │ │ ├── 1.78 │ │ │ ├── add-2025-08-04-page-auto-focus.md │ │ │ ├── add-2025-08-25-jupyter-include-section.md │ │ │ ├── add-2025-08-24-selected-text-menu.md │ │ │ └── add-2025-07-13-pages-without-chapter.md │ │ ├── 1.51 │ │ │ ├── doc-2021-06-26-brew.md │ │ │ ├── _fix-2021-07-03-flow-diagram-dash.md │ │ │ ├── add-2021-07-10-python-parsing.md │ │ │ ├── add-2021-07-11-py-doc-params.md │ │ │ └── add-2021-06-21-img-anntations-explicit-autopath.md │ │ ├── 1.69 │ │ │ ├── fix-2024-04-30-presentation-viewport.md │ │ │ ├── fix-2024-04-23-remove-title-quotes.md │ │ │ ├── fix-2024-04-30-auto-title-with-custom-ext.md │ │ │ ├── fix-2024-04-16-index-lookup.md │ │ │ ├── add-2024-05-06-initial-inline-code-in-header.md │ │ │ └── fix-2024-04-17-normalize-path-for-watch.md │ │ ├── 1.53 │ │ │ ├── _fix-2021-09-08-python-data-classes.md │ │ │ ├── add-2021-09-12-image-annotations-fit.md │ │ │ ├── _fix-2021-09-13-pydoc-assignment-parse-fix.md │ │ │ └── add-2021-09-13-pydoc-params-dash-name.md │ │ ├── 1.67 │ │ │ ├── add-2024-01-22-tabs-shorten-lines.md │ │ │ ├── add-2024-01-06-rename-snippet-no-gap-separator.md │ │ │ ├── add-2024-01-16-preview-anchor.md │ │ │ ├── add-2024-01-11-tabs-snippets-no-margin.md │ │ │ ├── add-2024-01-27-ssl-jks-option.md │ │ │ ├── fix-2024-01-06-code-snippet-anchor.md │ │ │ └── add-2024-01-28-ssl-pem-option.md │ │ ├── 1.81.1 │ │ │ ├── fix-2025-10-21-jupyter-output-muliple-no-gap.md │ │ │ └── add-2025-10-22-move-ssl-configs-to-env-var.md │ │ ├── 1.61.2 │ │ │ └── fix-2022-10-19-card-auxiliary-file.md │ │ ├── 2023.md │ │ └── 2024.md │ ├── layout │ │ ├── table │ │ │ ├── table-with-shortcuts.csv │ │ │ ├── table-mapping.csv │ │ │ ├── table-conflict.csv │ │ │ ├── table.csv │ │ │ ├── table-many-columns.csv │ │ │ └── table.json │ │ ├── table-markup.csv │ │ ├── instructions │ │ │ ├── cpp-install.md │ │ │ ├── java-install.md │ │ │ └── javascript-install.md │ │ ├── artifacts │ │ │ ├── generated-values.json │ │ │ └── names.json │ │ └── table-multiline.csv │ ├── references.json │ ├── configuration │ │ ├── basic.md │ │ └── top-header.md │ ├── synergy-with-testing │ │ ├── test.png │ │ └── rest-test.json │ ├── introduction │ │ ├── example.json │ │ └── getting-started-installation.md │ ├── extensions.json │ ├── plugins │ │ └── development.md │ ├── java │ │ ├── TransactionTypes.java │ │ ├── HelloWorldTest.java │ │ ├── HelloWorldMarkdown.java │ │ ├── references │ │ │ └── javadoc-references-demo.csv │ │ ├── HelloWorldWithInner.java │ │ └── auto-reference.md │ ├── doxygen │ │ └── src │ │ │ ├── structs.h │ │ │ └── math.h │ ├── hub │ │ ├── build-artifacts-watch.md │ │ └── introduction.md │ ├── deployment │ │ └── additional-files.md │ └── example-references │ │ └── api.md ├── example-sources.zip ├── readme │ ├── znai-cards.png │ ├── znai-charts.png │ ├── znai-search.png │ ├── znai-overview.png │ ├── znai-flow-diagram.png │ ├── znai-presentation.png │ ├── znai-api-parameters.png │ ├── znai-external-code.png │ └── znai-two-sides-tabs.png └── pre-filter │ ├── maven-plugin.xml │ ├── download-and-unzip.md │ ├── maven-plugin-llm.xml │ ├── maven-plugin-cfg.xml │ └── maven-deploy.xml ├── znai-website-gen └── src │ ├── test │ └── resources │ │ ├── a.java │ │ ├── b.groovy │ │ ├── style.css │ │ ├── test.md │ │ ├── captured-matched-lines.txt │ │ ├── captured-output.out │ │ ├── shortcuts-mapping.csv │ │ ├── captured-matched-lines-error.txt │ │ ├── table-with-shortcuts.csv │ │ ├── captured-output-empty-lines.out │ │ ├── test-optional.md │ │ ├── test-table-title-column.json │ │ ├── dummy.png │ │ ├── test-table.csv │ │ ├── image-darkness-ratio.png │ │ ├── test-template.md │ │ ├── test-table.json │ │ ├── test-with-marker.md │ │ ├── test-flow.md │ │ ├── graphviz-meta-conf.json │ │ └── person.svg │ └── main │ └── resources │ ├── favicon.png │ ├── static │ └── favicon │ │ └── default.png │ └── template │ ├── initial-page-loading.html │ └── redirect.html ├── znai-reactjs ├── src │ ├── doc-elements │ │ ├── search │ │ │ └── testData.jsx │ │ ├── default-elements │ │ │ └── SimpleText.css │ │ └── page │ │ │ └── Page.css │ └── react-app-env.d.ts ├── .prettierrc.json ├── .env ├── public │ ├── ui.jpg │ ├── idea.png │ ├── books.jpg │ ├── favicon.ico │ ├── idea-cropped.png │ ├── screenshot1.png │ ├── small-book.png │ ├── test-image.png │ ├── word-toolbar.jpg │ ├── editor-overview.png │ ├── placeholder-logo.png │ ├── static │ │ └── fonts │ │ │ ├── Lato-Bold.woff2 │ │ │ ├── Lato-Black.woff2 │ │ │ ├── Lato-Italic.woff2 │ │ │ ├── Lato-Light.woff2 │ │ │ ├── Lato-Regular.woff2 │ │ │ ├── Lato-BoldItalic.woff2 │ │ │ └── Lato-LightItalic.woff2 │ └── diamond.svg └── README.md ├── znai-cli └── src │ └── main │ └── resources │ ├── page-four.md │ ├── footer.md │ ├── page-three.md │ ├── lookup-paths │ ├── file-name.js │ ├── plugin-params.json │ ├── meta.json │ ├── page-two.md │ └── scaffold-index.md ├── znai-client └── test-documentation │ ├── toc │ ├── index.md │ ├── chapter-one │ └── page.md │ └── meta.json ├── znai-core └── src │ ├── test │ └── resources │ │ ├── highlight.txt │ │ ├── missing-highlight.txt │ │ ├── validationCode.ext │ │ ├── validationCode.cpp │ │ ├── api-params-missing-fields.json │ │ ├── file-with-similar-lines-empty.txt │ │ ├── file-replace-all.txt │ │ ├── file-with-missing-marker.txt │ │ ├── json-callouts.csv │ │ ├── jsonFileWithPaths.json │ │ ├── file-with-similar-lines.txt │ │ ├── sample-with-marker.py │ │ ├── test-account.json │ │ ├── json-callouts.json │ │ ├── api-params-missing-description.json │ │ ├── references │ │ └── test-references.csv │ │ ├── files.jar │ │ ├── files.zip │ │ ├── file-with-surround-marker.txt │ │ ├── file.txt │ │ ├── api-params-no-type.json │ │ ├── test.json │ │ ├── with-null.json │ │ ├── images │ │ ├── png-test.png │ │ └── test.svg │ │ ├── script.groovy │ │ ├── api-params-simple.json │ │ ├── file-with-empty-lines.txt │ │ ├── sample-with-multi-marker.py │ │ ├── file-with-scopes.txt │ │ └── multiple-lines-start-stop.txt │ └── main │ └── resources │ └── znai-version.txt ├── znai-tests └── src │ └── test │ └── groovy │ ├── sampledoc │ ├── chapter-one │ │ ├── target.md │ │ └── links.md │ ├── lookup-paths │ ├── extra-dir │ │ ├── file-three.txt │ │ └── file-four.json │ ├── extra-files │ │ └── file-one.txt │ ├── upload.txt │ ├── doxygen.json │ ├── page-redirects.csv │ ├── index.md │ ├── references.csv │ ├── chapter-two │ │ └── doxygen-from-zip.md │ ├── outside-chapter-file.md │ ├── toc │ └── meta.json │ ├── webtau.cfg.groovy │ └── doxygen.zip ├── znai-utils └── src │ └── test │ └── resources │ ├── single.txt │ ├── important │ └── meta.txt │ └── castle.jpg ├── znai-ddjt-docs └── ddjt │ ├── components-testing │ └── building-fakes.md │ ├── meta.json │ ├── lookup-paths │ ├── introduction │ └── getting-started.md │ ├── index.md │ └── toc ├── znai-utils-for-testing └── src │ └── main │ └── resources │ └── important │ └── meta.txt ├── znai-charts └── src │ └── test │ └── resources │ ├── not-enough-bar-data.csv │ └── multi-bar.csv ├── znai-enterprise-sample-server ├── .gitignore └── requirements.txt ├── znai-sphinx └── sphinx-sample-doc │ ├── xml-build │ └── meta.json │ ├── chapter-two │ ├── page-five.rst │ └── index.rst │ └── chapter-one │ ├── index.rst │ └── page-three.rst ├── znai-testing-examples └── examples │ ├── webtau.cfg.groovy │ └── rest │ └── restGet.groovy ├── znai-dist └── bin │ ├── znai │ ├── znai.cmd │ └── znai-gen ├── znai-java └── src │ └── test │ └── resources │ ├── EnumMarkdown.java │ ├── WithExtraLines.java │ ├── Enum.java │ └── Simple.java ├── znai-groovy └── src │ └── main │ └── resources │ └── sample.groovy ├── znai-server └── src │ └── main │ └── java │ └── org │ └── testingisdocumenting │ └── znai │ └── server │ └── requests.http ├── znai-typescript └── vite.config.ts ├── znai-custom-components └── .babelrc ├── znai-enterprise └── src │ ├── test │ └── resources │ │ └── monitor.config.json │ └── main │ └── java │ └── org │ └── testingisdocumenting │ └── znai │ └── enterprise │ └── storage │ └── DocumentationStorageFactory.java ├── znai-python └── src │ └── test │ └── resources │ ├── pydoc-pandas-like-example-no-params.txt │ └── pydoc-params.py ├── .travis.yml ├── znai-diagrams └── src │ └── test │ └── resources │ ├── diagram-with-urls.json │ ├── graphviz-meta-conf.json │ └── person.svg └── .gitignore /znai-maven-plugin-test/znai/index.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-docs/.gitignore: -------------------------------------------------------------------------------- 1 | znai/doxygen/html/* -------------------------------------------------------------------------------- /znai-docs/code-examples/python/utils.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/a.java: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/b.groovy: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-docs/znai/flow/data/test.json: -------------------------------------------------------------------------------- 1 | {"test": "json"} -------------------------------------------------------------------------------- /znai-docs/znai/snippets/cpp-surroundedby-scopes.cpp: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-reactjs/src/doc-elements/search/testData.jsx: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-cli/src/main/resources/page-four.md: -------------------------------------------------------------------------------- 1 | # Debugging 2 | -------------------------------------------------------------------------------- /znai-client/test-documentation/toc: -------------------------------------------------------------------------------- 1 | chapter-one 2 | page -------------------------------------------------------------------------------- /znai-core/src/test/resources/highlight.txt: -------------------------------------------------------------------------------- 1 | def a 2 | int b -------------------------------------------------------------------------------- /znai-docs/znai/snippets/urlsample.txt: -------------------------------------------------------------------------------- 1 | /my-app/feature-url -------------------------------------------------------------------------------- /znai-maven-plugin-test/znai/lookup-paths: -------------------------------------------------------------------------------- 1 | ../doxygen.zip -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/chapter-one/target.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-cli/src/main/resources/footer.md: -------------------------------------------------------------------------------- 1 | Contributions are welcome -------------------------------------------------------------------------------- /znai-docs/znai/custom.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/markdown-dir/inlined.md: -------------------------------------------------------------------------------- 1 | `:badge: 2.34` -------------------------------------------------------------------------------- /znai-maven-plugin-test/znai/toc: -------------------------------------------------------------------------------- 1 | chapter 2 | doxygen-from-zip -------------------------------------------------------------------------------- /znai-reactjs/.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 120 3 | } -------------------------------------------------------------------------------- /znai-reactjs/src/doc-elements/default-elements/SimpleText.css: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/lookup-paths: -------------------------------------------------------------------------------- 1 | ../doxygen.zip -------------------------------------------------------------------------------- /znai-cli/src/main/resources/page-three.md: -------------------------------------------------------------------------------- 1 | # Hello World 2 | 3 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/missing-highlight.txt: -------------------------------------------------------------------------------- 1 | def g 2 | def h -------------------------------------------------------------------------------- /znai-docs/znai/snippets/lines-to-highlight.txt: -------------------------------------------------------------------------------- 1 | class 2 | usefulAction -------------------------------------------------------------------------------- /znai-utils/src/test/resources/single.txt: -------------------------------------------------------------------------------- 1 | single resource 2 | file -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/style.css: -------------------------------------------------------------------------------- 1 | .custom-style { 2 | } -------------------------------------------------------------------------------- /znai-core/src/test/resources/validationCode.ext: -------------------------------------------------------------------------------- 1 | // example of 2 | myFunc() -------------------------------------------------------------------------------- /znai-ddjt-docs/ddjt/components-testing/building-fakes.md: -------------------------------------------------------------------------------- 1 | # Local Data 2 | -------------------------------------------------------------------------------- /znai-docs/znai/tracking.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/extra-dir/file-three.txt: -------------------------------------------------------------------------------- 1 | file-three -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/extra-files/file-one.txt: -------------------------------------------------------------------------------- 1 | file-one -------------------------------------------------------------------------------- /znai-client/test-documentation/index.md: -------------------------------------------------------------------------------- 1 | # Hello Index 2 | 3 | starting page -------------------------------------------------------------------------------- /znai-core/src/test/resources/validationCode.cpp: -------------------------------------------------------------------------------- 1 | // example of 2 | myFuncTwo() -------------------------------------------------------------------------------- /znai-docs/znai/doxygen.json: -------------------------------------------------------------------------------- 1 | { 2 | "indexPath": "doxygen/xml/index.xml" 3 | } -------------------------------------------------------------------------------- /znai-docs/znai/snippets/ocaml/api.mli: -------------------------------------------------------------------------------- 1 | module Game : sig 2 | type t 3 | end -------------------------------------------------------------------------------- /znai-docs/znai/snippets/simple.json: -------------------------------------------------------------------------------- 1 | [{"key1": "value1"}, {"key2": "value2"}] -------------------------------------------------------------------------------- /znai-utils-for-testing/src/main/resources/important/meta.txt: -------------------------------------------------------------------------------- 1 | hello meta 2 | txt -------------------------------------------------------------------------------- /znai-charts/src/test/resources/not-enough-bar-data.csv: -------------------------------------------------------------------------------- 1 | x 2 | one 3 | two 4 | xyz -------------------------------------------------------------------------------- /znai-core/src/main/resources/znai-version.txt: -------------------------------------------------------------------------------- 1 | ${project.version} ${build.timestamp} -------------------------------------------------------------------------------- /znai-ddjt-docs/ddjt/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "ddjt", 3 | "type": "Guide" 4 | } -------------------------------------------------------------------------------- /znai-docs/code-examples/python/my_func_usage.py: -------------------------------------------------------------------------------- 1 | def example(): 2 | my_func(100) -------------------------------------------------------------------------------- /znai-docs/znai/demo-run-book/release-notes.md: -------------------------------------------------------------------------------- 1 | :include-markdowns: release-notes 2 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/markdown-dir/inlined-alternative.md: -------------------------------------------------------------------------------- 1 | `:badge: 2.44_internal` -------------------------------------------------------------------------------- /znai-docs/znai/visuals/data.csv: -------------------------------------------------------------------------------- 1 | label, value 2 | A, 10 3 | B, 20 4 | C, 15 5 | D, 8 -------------------------------------------------------------------------------- /znai-maven-plugin-test/znai/doxygen.json: -------------------------------------------------------------------------------- 1 | { 2 | "indexPath": "xml/index.xml" 3 | } -------------------------------------------------------------------------------- /znai-reactjs/.env: -------------------------------------------------------------------------------- 1 | EXTEND_ESLINT=true 2 | GENERATE_SOURCEMAP=false 3 | BROWSER=chrome -------------------------------------------------------------------------------- /znai-utils/src/test/resources/important/meta.txt: -------------------------------------------------------------------------------- 1 | second hello meta 2 | second txt -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test.md: -------------------------------------------------------------------------------- 1 | # sample 2 | 3 | markdown is *simple* -------------------------------------------------------------------------------- /znai-core/src/test/resources/api-params-missing-fields.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | } 4 | ] 5 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/file-with-similar-lines-empty.txt: -------------------------------------------------------------------------------- 1 | $prompt > 2 | $prompt > -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/doc-2021-10-22-example-section.md: -------------------------------------------------------------------------------- 1 | * Doc: more examples -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-11-card.md: -------------------------------------------------------------------------------- 1 | * Add: [Cards](visuals/cards) -------------------------------------------------------------------------------- /znai-docs/znai/snippets/cli/command.txt: -------------------------------------------------------------------------------- 1 | my-captured-command --param=10 --another=value -------------------------------------------------------------------------------- /znai-docs/znai/snippets/incomplete.json: -------------------------------------------------------------------------------- 1 | { 2 | "config": { 3 | ... 4 | } 5 | } -------------------------------------------------------------------------------- /znai-docs/znai/snippets/replace-all-group.txt: -------------------------------------------------------------------------------- 1 | hello1 world2 2 | another3 line4 3 | 4 | -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/upload.txt: -------------------------------------------------------------------------------- 1 | extra-files/file-one.txt 2 | extra-dir -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/captured-matched-lines.txt: -------------------------------------------------------------------------------- 1 | line two 2 | line three -------------------------------------------------------------------------------- /znai-cli/src/main/resources/lookup-paths: -------------------------------------------------------------------------------- 1 | ../../path-to-files 2 | ../../path-to-test-artifacts -------------------------------------------------------------------------------- /znai-docs/znai/demo-run-book/release-notes/20170110.md: -------------------------------------------------------------------------------- 1 | # 0.1 2 | 3 | done this and that 4 | -------------------------------------------------------------------------------- /znai-docs/znai/demo-run-book/release-notes/20170123.md: -------------------------------------------------------------------------------- 1 | # 0.1.1 2 | 3 | fixed this and that -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-07-15-win-cmd.md: -------------------------------------------------------------------------------- 1 | * Add Windows znai.cmd script 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-10-23-html-block.md: -------------------------------------------------------------------------------- 1 | * Add: Support for HTML block -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/doxygen.json: -------------------------------------------------------------------------------- 1 | { 2 | "indexPath": "xml/index.xml" 3 | } -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/captured-output.out: -------------------------------------------------------------------------------- 1 | line one 2 | line two 3 | line three -------------------------------------------------------------------------------- /znai-client/test-documentation/chapter-one/page.md: -------------------------------------------------------------------------------- 1 | # Page Section 2 | 3 | Text goes here changed -------------------------------------------------------------------------------- /znai-core/src/test/resources/file-replace-all.txt: -------------------------------------------------------------------------------- 1 | foo foo foo 2 | bar bar bar 3 | test12 great16 -------------------------------------------------------------------------------- /znai-core/src/test/resources/file-with-missing-marker.txt: -------------------------------------------------------------------------------- 1 | $prompt > 2 | some output 3 | goes here -------------------------------------------------------------------------------- /znai-core/src/test/resources/json-callouts.csv: -------------------------------------------------------------------------------- 1 | root.id, root id 2 | root.price, root *price* 3 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/jsonFileWithPaths.json: -------------------------------------------------------------------------------- 1 | [ 2 | "root.key1", 3 | "root.key2" 4 | ] -------------------------------------------------------------------------------- /znai-docs/znai/demo-run-book/release-notes/20170127.md: -------------------------------------------------------------------------------- 1 | # 0.2 2 | 3 | another minor release test -------------------------------------------------------------------------------- /znai-docs/znai/flow/shortcuts.md: -------------------------------------------------------------------------------- 1 | # Keyboard shortcuts 2 | 3 | :include-table: shortcuts.csv 4 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-08-19-scala-highlight.md: -------------------------------------------------------------------------------- 1 | * Added Scala syntax highlight -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-09-18-ocaml-highlight.md: -------------------------------------------------------------------------------- 1 | * Add: OCaml syntax highlight -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.76/add-2025-05-19-em-dash.md: -------------------------------------------------------------------------------- 1 | * Add: Convert `---` into em-dash. -------------------------------------------------------------------------------- /znai-docs/znai/snippets/code-reference-inlined-code-example.md: -------------------------------------------------------------------------------- 1 | Use `fapi.book` to book a flight. -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/extra-dir/file-four.json: -------------------------------------------------------------------------------- 1 | { 2 | "message": "file-four" 3 | } -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/page-redirects.csv: -------------------------------------------------------------------------------- 1 | chapter-three/page-one,chapter-one/links -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/shortcuts-mapping.csv: -------------------------------------------------------------------------------- 1 | +, Supported 2 | -, **Not supported** -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-03-more-permissive-json.md: -------------------------------------------------------------------------------- 1 | * More permissive json parsing -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-01-text-badge.md: -------------------------------------------------------------------------------- 1 | * Add [text badge](visuals/text-badge) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/doc-2024-09-03-styling.md: -------------------------------------------------------------------------------- 1 | * Doc: How to [style](configuration/styling) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/fix-2025-04-26-slf4j-warning.md: -------------------------------------------------------------------------------- 1 | * Fix: Remove slf4j logger warning -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.79/add-2025-09-07-slack-env-var.md: -------------------------------------------------------------------------------- 1 | * Add: Slack setup via env variable -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.82/doc-2025-11-02-jupyter.md: -------------------------------------------------------------------------------- 1 | * Doc: Jupyter improved example for docs -------------------------------------------------------------------------------- /znai-docs/znai/snippets/cli/file-path-of-asserted-lines.txt: -------------------------------------------------------------------------------- 1 | statusCode equals 200 2 | executed HTTP GET -------------------------------------------------------------------------------- /znai-docs/znai/visuals/graphviz.dot: -------------------------------------------------------------------------------- 1 | digraph { 2 | a -> b; 3 | b -> c; 4 | d -> b; 5 | b -> e; 6 | } -------------------------------------------------------------------------------- /znai-enterprise-sample-server/.gitignore: -------------------------------------------------------------------------------- 1 | # Python 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | -------------------------------------------------------------------------------- /znai-enterprise-sample-server/requirements.txt: -------------------------------------------------------------------------------- 1 | flask==3.0.0 2 | flask-cors==4.0.0 3 | slack-sdk==3.26.1 -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/captured-matched-lines-error.txt: -------------------------------------------------------------------------------- 1 | wrong line two 2 | wrong line three -------------------------------------------------------------------------------- /znai-client/test-documentation/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Demo Product", 3 | "type": "User Guide" 4 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-11-xml-path-validation.md: -------------------------------------------------------------------------------- 1 | * Validate XML path for highlighting -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-21-footer-change-detect.md: -------------------------------------------------------------------------------- 1 | * Preview footer change detection -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-08-11-page-toc.md: -------------------------------------------------------------------------------- 1 | * Add [Page Table Of Contents](flow/page-toc) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-14-heading-style.md: -------------------------------------------------------------------------------- 1 | * Add [API heading style](visuals/headings) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/_fix-2021-11-30-win-cmd.md: -------------------------------------------------------------------------------- 1 | * Fix: win cmd script to include passed params -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/add-2021-11-25-cli-fence.md: -------------------------------------------------------------------------------- 1 | * Add [CLI fence plugin](snippets/CLI) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/fix-2022-05-20-toc-selected-padding.md: -------------------------------------------------------------------------------- 1 | * Fix: selected TOC item padding -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-20-support-title.md: -------------------------------------------------------------------------------- 1 | * Add [Support Title](flow/support) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-22-json-order.md: -------------------------------------------------------------------------------- 1 | * Fix: [JSON](snippets/json) rendering order -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-08-30-image-anchor.md: -------------------------------------------------------------------------------- 1 | * Add: Image [Anchor](visuals/images#anchor) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-08-30-table-anchor.md: -------------------------------------------------------------------------------- 1 | * Add: Table [Anchor](layout/tables#anchor) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-08-table-no-gap.md: -------------------------------------------------------------------------------- 1 | * Add: Table [No Gap](layout/tables#no-gap) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-11-03-experimental-top-header.md: -------------------------------------------------------------------------------- 1 | * Add: Experimental top header -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.80/add-2025-09-09-highlight-svg.md: -------------------------------------------------------------------------------- 1 | * Add: SVG support for Slack/Generate Link -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.84/add-2025-12-10-mermaid-upgrade.md: -------------------------------------------------------------------------------- 1 | * Add: Mermaid diagrams version 11.12 -------------------------------------------------------------------------------- /znai-docs/znai/snippets/book-store-paths.json: -------------------------------------------------------------------------------- 1 | ["root.store.book[1].category", "root.store.book[2].category"] -------------------------------------------------------------------------------- /znai-docs/znai/visuals/charts/genres.csv: -------------------------------------------------------------------------------- 1 | genre, preference 2 | RPG, 75 3 | Action, 50 4 | RTS, 40 5 | FPS, 50 -------------------------------------------------------------------------------- /znai-reactjs/src/react-app-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | declare module "*.css"; 3 | -------------------------------------------------------------------------------- /znai-sphinx/sphinx-sample-doc/xml-build/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "sphinx-test", 3 | "type": "Guide" 4 | } -------------------------------------------------------------------------------- /znai-core/src/test/resources/file-with-similar-lines.txt: -------------------------------------------------------------------------------- 1 | $prompt > 2 | some output 3 | goes here 4 | $prompt > -------------------------------------------------------------------------------- /znai-core/src/test/resources/sample-with-marker.py: -------------------------------------------------------------------------------- 1 | # example: how to print 2 | print("hello") 3 | # example-end -------------------------------------------------------------------------------- /znai-core/src/test/resources/test-account.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "id1", 3 | "price": 100, 4 | "amount": 30 5 | } -------------------------------------------------------------------------------- /znai-docs/znai/layout/table/table-with-shortcuts.csv: -------------------------------------------------------------------------------- 1 | Feature Name, V1, V2 2 | featureA, +, + 3 | featureB, -, + -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/_fix-2021-05-16-back-button.md: -------------------------------------------------------------------------------- 1 | * Fix: restore scroll position on back button -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-12-json-path-validation.md: -------------------------------------------------------------------------------- 1 | * Validate JSON path for highlighting -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-09-05-log-rotation-enterprise.md: -------------------------------------------------------------------------------- 1 | * Add enterprise server log rotation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-01-07-plugins-stats.md: -------------------------------------------------------------------------------- 1 | * Generate plugins usage statistics file 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-08-13-open-api3.md: -------------------------------------------------------------------------------- 1 | * Add [Open API 3](snippets/open-API) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-07-02-json-callouts.md: -------------------------------------------------------------------------------- 1 | * Add: [JSON callouts](snippets/json#callouts) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-09-07-upload-txt.md: -------------------------------------------------------------------------------- 1 | * Add: [upload.txt](deployment/additional-files) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/add-2024-08-28-default-tabs.md: -------------------------------------------------------------------------------- 1 | * Add: [Default Tab](layout/tabs#default-tab) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-10-01-search-hotkey.md: -------------------------------------------------------------------------------- 1 | * Add: [Search](flow/search) hotkey indicator -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/add-2025-04-28-readmore-plugin.md: -------------------------------------------------------------------------------- 1 | * Add: [`readmore`](visuals/read-more) plugin -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.77/add-2025-07-06-initial-llm.md: -------------------------------------------------------------------------------- 1 | * Add: Initial [LLM](flow/llm) context support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.82/add-2025-11-02-jupyter-example.md: -------------------------------------------------------------------------------- 1 | * Add: Jupyter dataframes align cells right -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.83/fix-2025-11-09-llm-txt-fix-links.md: -------------------------------------------------------------------------------- 1 | * Fix: `llm.txt` correctly renders links -------------------------------------------------------------------------------- /znai-docs/znai/snippets/ocaml/api.ml: -------------------------------------------------------------------------------- 1 | module Game = struct 2 | type t = { 3 | name: string 4 | } 5 | end -------------------------------------------------------------------------------- /znai-reactjs/public/ui.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/ui.jpg -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/chapter-one/links.md: -------------------------------------------------------------------------------- 1 | [wrong external link](https://nothing___wrong__address) -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/index.md: -------------------------------------------------------------------------------- 1 | # This is Landing/Index page 2 | 3 | [test](#test) 4 | 5 | # test -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/webtau.cfg.groovy: -------------------------------------------------------------------------------- 1 | browserWidth = 1280 2 | browserHeight = 920 3 | browserId = "firefox" -------------------------------------------------------------------------------- /znai-core/src/test/resources/json-callouts.json: -------------------------------------------------------------------------------- 1 | { 2 | "root.id": "root id", 3 | "root.price": "root *price*" 4 | } -------------------------------------------------------------------------------- /znai-docs/znai/layout/table/table-mapping.csv: -------------------------------------------------------------------------------- 1 | +, `:icon: check {stroke: "green"}` 2 | -, `:icon: slash {stroke: "red"}` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/_fix-2021-05-10-xml-align-render.md: -------------------------------------------------------------------------------- 1 | * Fix: XML alignment and remove extra empty line -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-22-click-to-zoom-img.md: -------------------------------------------------------------------------------- 1 | * Add click to zoom image that was `fit: true` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-09-17-tabs-validation.md: -------------------------------------------------------------------------------- 1 | * Add [Tabs](layout/tabs) presence validation 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/_fix-2021-12-02-snippet-highlight-regression.md: -------------------------------------------------------------------------------- 1 | * Fix: snippets highlight regression -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-02-25-optional-index.md: -------------------------------------------------------------------------------- 1 | * [index.md](flow/landing) is now optional 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-14-chart-legend.md: -------------------------------------------------------------------------------- 1 | * Add [chart legend](visuals/charts#legend) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-05-30-version-cli-param.md: -------------------------------------------------------------------------------- 1 | * Add `--version` param to `znai` CLI 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-13-json-fence-plugin.md: -------------------------------------------------------------------------------- 1 | * Add [JSON](snippets/json) fence plugin 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-21-image-title.md: -------------------------------------------------------------------------------- 1 | * New [Image Title](visuals/images#title) look and feel -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-03-template-rework.md: -------------------------------------------------------------------------------- 1 | * Rework [Templates](layout/templates) example -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-16-cpp-chapter.md: -------------------------------------------------------------------------------- 1 | * Doc: Move [CPP](CPP/doxygen-setup) to its own chapter -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-21-empty-column.md: -------------------------------------------------------------------------------- 1 | * Fix: Empty [Column](layout/columns) rendering crash -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-22-ipad-search.md: -------------------------------------------------------------------------------- 1 | * Fix: search popup on iPad now fits a browser window -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-08-table-collapsed.md: -------------------------------------------------------------------------------- 1 | * Add: Table [Collapse](layout/tables#collapse) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-10-28-enum-formal-params.md: -------------------------------------------------------------------------------- 1 | * Add: enum type formal parameters for plugins -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-10-30-json-anchorid.md: -------------------------------------------------------------------------------- 1 | * Add: JSON [anchor id](snippets/json#anchor) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-06-27-java-17.md: -------------------------------------------------------------------------------- 1 | * Add: Java 17 is a minimum java version required to run -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/add-2023-12-06-iframe-title.md: -------------------------------------------------------------------------------- 1 | * Add: [IFrame title](visuals/iframe#title) parameter -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-03-07-doxygen-note.md: -------------------------------------------------------------------------------- 1 | * Add: Display [Doxygen](CPP/doxygen-setup) `@note` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-03-02-asciinema.md: -------------------------------------------------------------------------------- 1 | * Add: Initial [Asciinema](visuals/asciinema) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/add-2025-10-19-scaffold-custom-content.md: -------------------------------------------------------------------------------- 1 | * Add: `znai new` custom content scaffold -------------------------------------------------------------------------------- /znai-docs/znai/snippets/markdown-dir/getting-started-step-external.md: -------------------------------------------------------------------------------- 1 | ```cli 2 | command specific-to-external 3 | ``` -------------------------------------------------------------------------------- /znai-reactjs/public/idea.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/idea.png -------------------------------------------------------------------------------- /znai-testing-examples/examples/webtau.cfg.groovy: -------------------------------------------------------------------------------- 1 | browserWidth = 1000 2 | browserHeight = 800 3 | browserId = "firefox" -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/references.csv: -------------------------------------------------------------------------------- 1 | fapi.book, chapter-one/links 2 | fapi.query, chapter-one/target -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/table-with-shortcuts.csv: -------------------------------------------------------------------------------- 1 | Feature Name, V1, V2 2 | featureA, +, + 3 | featureB, -, + -------------------------------------------------------------------------------- /znai-charts/src/test/resources/multi-bar.csv: -------------------------------------------------------------------------------- 1 | x,price,tax,service fee 2 | one, 10, 5, 3 3 | two, 30, 6, 1 4 | xyz, 40, 2, 4 -------------------------------------------------------------------------------- /znai-core/src/test/resources/api-params-missing-description.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "name": "firstName" 4 | } 5 | ] 6 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/references/test-references.csv: -------------------------------------------------------------------------------- 1 | MyClass, reference/my-class 2 | YourClass, reference/your-class -------------------------------------------------------------------------------- /znai-docs/example-sources.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/example-sources.zip -------------------------------------------------------------------------------- /znai-docs/readme/znai-cards.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-cards.png -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-07-24-table-wide-mode.md: -------------------------------------------------------------------------------- 1 | * Add Table [wide mode](layout/tables#wide-mode) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/add-2021-11-12-selection-dark-theme.md: -------------------------------------------------------------------------------- 1 | * Tweaked text selection color for dark theme 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-02-06-open-api-loop.md: -------------------------------------------------------------------------------- 1 | * Handle loop reference in [Open API](snippets/open-API) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-14-python-cache.md: -------------------------------------------------------------------------------- 1 | * Add caching to [Python Parsing](python/auto-reference) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/fix-2022-09-06-image-mobile-fit.md: -------------------------------------------------------------------------------- 1 | * Fix: [Fit Image](visuals/images#fit) in mobile view -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-02-28-doxygen-noexcept.md: -------------------------------------------------------------------------------- 1 | * Add: Display [Doxygen](CPP/doxygen-setup) `noexcept` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-02-29-doxygen-decltype.md: -------------------------------------------------------------------------------- 1 | * Add: Display [Doxygen](CPP/doxygen-setup) `decltype` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-10-19-initial-footnotes.md: -------------------------------------------------------------------------------- 1 | * Add: Initial [Footnotes](flow/footnotes) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/add-2024-11-10-footnote-style-tweaks.md: -------------------------------------------------------------------------------- 1 | * Add: [Footnote](flow/footnotes) update styles -------------------------------------------------------------------------------- /znai-docs/znai/visuals/idea.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/idea.png -------------------------------------------------------------------------------- /znai-maven-plugin-test/znai/chapter/doxygen-from-zip.md: -------------------------------------------------------------------------------- 1 | # From Zip 2 | 3 | :include-doxygen-doc: utils::nested::my_func -------------------------------------------------------------------------------- /znai-reactjs/public/books.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/books.jpg -------------------------------------------------------------------------------- /znai-reactjs/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/favicon.ico -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/captured-output-empty-lines.out: -------------------------------------------------------------------------------- 1 | 2 | line one 3 | 4 | line two 5 | 6 | line three 7 | -------------------------------------------------------------------------------- /znai-cli/src/main/resources/file-name.js: -------------------------------------------------------------------------------- 1 | class JsClass { 2 | constructor() { 3 | } 4 | } 5 | 6 | export default JsClass -------------------------------------------------------------------------------- /znai-ddjt-docs/ddjt/lookup-paths: -------------------------------------------------------------------------------- 1 | ../../znai-testing-examples/src/test/groovy 2 | ../../znai-testing-examples/src/test/java 3 | -------------------------------------------------------------------------------- /znai-docs/readme/znai-charts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-charts.png -------------------------------------------------------------------------------- /znai-docs/readme/znai-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-search.png -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-03-enterprise-validate-path.md: -------------------------------------------------------------------------------- 1 | * Enterprise file monitor validates monitor path -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-03-port-info-on-busy-port.md: -------------------------------------------------------------------------------- 1 | * Prints port info when port is taken during preview -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-22-scale-param-img.md: -------------------------------------------------------------------------------- 1 | * Rename `scaleRatio` -> `scale` for `include-image` plugin -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-10-10-upload-zip.md: -------------------------------------------------------------------------------- 1 | * Add `uploadzip` command to upload any html zip to znai hub -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-01-08-plugins-params-stats.md: -------------------------------------------------------------------------------- 1 | * Generate plugin params usage statistics file 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/fix-2022-02-20-search-highlight-across.md: -------------------------------------------------------------------------------- 1 | * Fix: search result preview highlight across styles -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-13-bar-chart-stack.md: -------------------------------------------------------------------------------- 1 | * Add stack mode to [Bar Chart](visuals/charts#bar) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-18-charts-fence.md: -------------------------------------------------------------------------------- 1 | * Add [Charts Inlined Data](visuals/charts#inlined-data) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-18-charts-wide-mode.md: -------------------------------------------------------------------------------- 1 | * Add [Charts Wide Mode](visuals/charts#wide-mode) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-08-makdown-snippet-code-color.md: -------------------------------------------------------------------------------- 1 | * Tweak color of code snippets of lang=markdown -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-15-java-chapter.md: -------------------------------------------------------------------------------- 1 | * Doc: Move [Java](java/content-extraction) to its own chapter -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-20-image-border.md: -------------------------------------------------------------------------------- 1 | * Fix: [Image](visuals/images#border) bottom border rendering -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-07-12-python-decorator-highlight.md: -------------------------------------------------------------------------------- 1 | * Fix: highlight python code snippet decorator -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/add-2022-08-21-plant-uml-bump.md: -------------------------------------------------------------------------------- 1 | * [PlantUml](visuals/PlantUml) version bump to `1.2022.6` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-08-31-table-formal-params.md: -------------------------------------------------------------------------------- 1 | * Add: [Table](layout/tables) formal parameters support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-01-java-anchor-id.md: -------------------------------------------------------------------------------- 1 | * Add: Java content [Anchor](java/content-extraction#anchor) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-07-image-mobile-padding.md: -------------------------------------------------------------------------------- 1 | * Remove [Image](visuals/images) padding in mobile view -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-08-api-params-gap.md: -------------------------------------------------------------------------------- 1 | * Add: API Parameters [No Gap](snippets/api-parameters#no-gap) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-11-third-column.md: -------------------------------------------------------------------------------- 1 | * Add: Three columns [Layout](layout/columns#three-columns)**** -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/doc-2022-08-23-local-build.md: -------------------------------------------------------------------------------- 1 | * Doc: [Local Build](znai-development/local-build) instructions -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61.1/fix-2022-10-04-null-pointer-create-url.md: -------------------------------------------------------------------------------- 1 | * Fix: Null Pointer in some cases of URL resolve -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61/add-2022-09-28-table-filter-regexp.md: -------------------------------------------------------------------------------- 1 | * Add: [Table Regexp Filter](layout/tables#filter-rows) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2022-12-19-cli-output-wide.md: -------------------------------------------------------------------------------- 1 | * Add: [Wide Mode](snippets/CLI#wide-mode) for CLI Output -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/add-2023-11-16-iframe-mobile-gap.md: -------------------------------------------------------------------------------- 1 | * Add: [IFrame content](visuals/iframe) no gap on mobile -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-04-02-toc-title-override.md: -------------------------------------------------------------------------------- 1 | * Add: Page [title overrides](flow/names) via `toc` file -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.70/fix-2024-05-29-view-on-index.md: -------------------------------------------------------------------------------- 1 | * Fix: `viewOn` link correctly adds `.md` to the index page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-11-02-graphviz-align.md: -------------------------------------------------------------------------------- 1 | * Add: [Graphviz](visuals/graphviz-diagrams) `align` option -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.79/add-2025-08-31-ask-in-slack-bubble-toggle.md: -------------------------------------------------------------------------------- 1 | * Add: Hide/show ask in slack bubble when clicking -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/add-2025-10-19-page-redirects.md: -------------------------------------------------------------------------------- 1 | * Add: `page-redirects.csv` support to help with page renames -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.83/add-2025-11-09-search-entries-extra-fields.md: -------------------------------------------------------------------------------- 1 | * Add: `search-entries.xml` add extra fields -------------------------------------------------------------------------------- /znai-docs/znai/snippets/trader.json: -------------------------------------------------------------------------------- 1 | { 2 | "trader": { 3 | "firstName": "John", 4 | "lastName": "Smith" 5 | } 6 | } -------------------------------------------------------------------------------- /znai-docs/znai/visuals/books.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/books.jpg -------------------------------------------------------------------------------- /znai-docs/znai/visuals/castle.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/castle.jpg -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test-optional.md: -------------------------------------------------------------------------------- 1 | # sample of optional instructions 2 | 3 | extra steps markdown is *simple* -------------------------------------------------------------------------------- /znai-dist/bin/znai: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | CWD=`dirname "$0"` 3 | java -cp "$CWD/lib/*" org.testingisdocumenting.znai.cli.ZnaiCliApp $* 4 | -------------------------------------------------------------------------------- /znai-dist/bin/znai.cmd: -------------------------------------------------------------------------------- 1 | @echo off 2 | SET CWD=%~dp0 3 | java -cp "%CWD%\\lib\\*" org.testingisdocumenting.znai.cli.ZnaiCliApp %* 4 | -------------------------------------------------------------------------------- /znai-docs/readme/znai-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-overview.png -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/_fix-2021-05-18-meta-merge.md: -------------------------------------------------------------------------------- 1 | * Fix: `include-meta` does not override plugin specific meta anymore -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-07-21-table-percentage-width.md: -------------------------------------------------------------------------------- 1 | * Add [Table](layout/tables#width) percentage width 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-04-text-badge-header.md: -------------------------------------------------------------------------------- 1 | * Add [heading text badge](visuals/text-badge#part-of-heading) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-14-chart-dark-theme.md: -------------------------------------------------------------------------------- 1 | * Add dark theme support for [Charts](visuals/charts) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-24-doxygen-from-zip.md: -------------------------------------------------------------------------------- 1 | * Add [Doxygen From Zip](CPP/doxygen-setup#setup) support 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-02-mermaid-wide.md: -------------------------------------------------------------------------------- 1 | * [Mermaid Diagrams Wide Mode](visuals/mermaid-diagrams#wide-mode) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-06-20-json-webtau-example.md: -------------------------------------------------------------------------------- 1 | * Doc: [JSON WebTau example](snippets/json#test-results) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-06-21-columns.md: -------------------------------------------------------------------------------- 1 | * Doc: Update [Columns](layout/columns) examples and text refactoring -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-15-python-chapter.md: -------------------------------------------------------------------------------- 1 | * Doc: Move [Python](python/content-extraction) to its own chapter -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-04-ipad-layout-fix.md: -------------------------------------------------------------------------------- 1 | * Fix: iPad layout adjustments to battle 100vh rendering feature -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-07-08-python-multiline-color.md: -------------------------------------------------------------------------------- 1 | * Fix: Python multi-line token color during snippet render -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-01-python-anchor.md: -------------------------------------------------------------------------------- 1 | * Add: Python content [Anchor](python/content-extraction#anchor) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61/doc-2022-09-29-table-multiline.md: -------------------------------------------------------------------------------- 1 | * Doc: [Table Multiline Content](layout/tables#multiline-content) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61/fix-2022-09-30-index-title.md: -------------------------------------------------------------------------------- 1 | * Fix: [page title](flow/names#name-overrides) override for index page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-11-02-card-table.md: -------------------------------------------------------------------------------- 1 | * Add: [Table](layout/tables) and [Card](visuals/cards) integration -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-11-26-report-unknown-inlined-code-plugin.md: -------------------------------------------------------------------------------- 1 | * Add: Report misprinted inlined code plugin -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/doc-2022-11-29-open-api-prop-title.md: -------------------------------------------------------------------------------- 1 | * Add: handle property title in [Open API](snippets/open-API) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/fix-2023-02-06-json-null.md: -------------------------------------------------------------------------------- 1 | * Fix: [JSON](snippets/json) regression with displaying `null` values -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-03-01-plugin-params-rename.md: -------------------------------------------------------------------------------- 1 | * Add: plugin parameter names deprecation (rename) mechanism -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.65/add-2023-11-06-plantuml-bsd.md: -------------------------------------------------------------------------------- 1 | * Add: [Plant UML](visuals/PlantUml) use `BSD` license as dependency -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-03-26-specify-extension-in-toc.md: -------------------------------------------------------------------------------- 1 | * Add: Support explicit file name extension in `toc` file -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-10-05-custom-anchor-id.md: -------------------------------------------------------------------------------- 1 | * Add: Custom [Anchor Id](flow/page-references#custom-anchor-id) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-10-05-dollar-latex-inline.md: -------------------------------------------------------------------------------- 1 | * Add: [Latex Math](snippets/math) inline `$` shortcut support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-10-07-dollar-latex-block.md: -------------------------------------------------------------------------------- 1 | * Add: [Latex Math](snippets/math) block `$$` shortcut support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-11-02-heading-link-support.md: -------------------------------------------------------------------------------- 1 | * Add: [Headings](flow/structure) support for links inside -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-02-25-ocaml-inline-comments.md: -------------------------------------------------------------------------------- 1 | * Add: OCaml [Code Comments](snippets/code-comments) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.78.1/fix-2025-08-26-remove-ask-in-slack-bubble.md: -------------------------------------------------------------------------------- 1 | * Fix: Remove ask-in-slack bubble on page navigation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.78/add-2025-08-04-page-auto-focus.md: -------------------------------------------------------------------------------- 1 | * Add: Focus the main page content on-load, navigation, and search -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.80/add-2025-09-14-highlight-inside-spoiler.md: -------------------------------------------------------------------------------- 1 | * Add: highlight Slack questions inside spoiler block -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.83/add-2025-11-08-expose-llm-txt.md: -------------------------------------------------------------------------------- 1 | * Add: Option to expose llm.txt during build to be pushed to repo -------------------------------------------------------------------------------- /znai-docs/znai/snippets/Hello.sc: -------------------------------------------------------------------------------- 1 | object Hello { 2 | def main(args: Array[String]) = { 3 | println("Hello, world") 4 | } 5 | } -------------------------------------------------------------------------------- /znai-maven-plugin-test/doxygen.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-maven-plugin-test/doxygen.zip -------------------------------------------------------------------------------- /znai-reactjs/public/idea-cropped.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/idea-cropped.png -------------------------------------------------------------------------------- /znai-reactjs/public/screenshot1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/screenshot1.png -------------------------------------------------------------------------------- /znai-reactjs/public/small-book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/small-book.png -------------------------------------------------------------------------------- /znai-reactjs/public/test-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/test-image.png -------------------------------------------------------------------------------- /znai-reactjs/public/word-toolbar.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/word-toolbar.jpg -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/chapter-two/doxygen-from-zip.md: -------------------------------------------------------------------------------- 1 | # From Zip 2 | 3 | :include-doxygen-doc: utils::nested::my_func -------------------------------------------------------------------------------- /znai-core/src/test/resources/files.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-core/src/test/resources/files.jar -------------------------------------------------------------------------------- /znai-core/src/test/resources/files.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-core/src/test/resources/files.zip -------------------------------------------------------------------------------- /znai-docs/readme/znai-flow-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-flow-diagram.png -------------------------------------------------------------------------------- /znai-docs/readme/znai-presentation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-presentation.png -------------------------------------------------------------------------------- /znai-docs/znai/references.json: -------------------------------------------------------------------------------- 1 | { 2 | "fapi.book": "example-references/api#book", 3 | "fapi.query": "example-references/api#query" 4 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.51/doc-2021-06-26-brew.md: -------------------------------------------------------------------------------- 1 | * Doc: [brew install instruction](introduction/getting-started#command-line-brew) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-07-22-table-column-min-width.md: -------------------------------------------------------------------------------- 1 | * Add Table [column min width](layout/tables#min-width) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-08-16-table-highlight-row.md: -------------------------------------------------------------------------------- 1 | * Added [Table row highlight](layout/tables#highlight) by index -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-09-28-graphviz-include-plugin.md: -------------------------------------------------------------------------------- 1 | * Add [graphviz](visuals/graphviz-diagrams) include plugin -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/add-2021-12-27-replace.md: -------------------------------------------------------------------------------- 1 | * Add [Replace](snippets/snippets-manipulation#replace) snippet manipulation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/fix-2022-05-09-fix-markdown-snippet-render.md: -------------------------------------------------------------------------------- 1 | * Fix: markdown snippets render extra new line at the end -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-07-java-plugins-params-formalization.md: -------------------------------------------------------------------------------- 1 | * Add Java Plugins parameters definition 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-02-icons-table-example.md: -------------------------------------------------------------------------------- 1 | * Doc: [Table with Icons](visuals/icons#inside-tables) example -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-07-08-python-multi-line.md: -------------------------------------------------------------------------------- 1 | * Fix: python multiline string parsing to properly highlight lines -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-07-16-doxygen-method-link-color.md: -------------------------------------------------------------------------------- 1 | * Fix: [CPP Auto Ref](CPP/auto-reference) method link color -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61.1/fix-2022-10-04-more-stack-trace.md: -------------------------------------------------------------------------------- 1 | * Fix: Display stacktrace within plugin to identify problems easier -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-11-21-inline-markdown.md: -------------------------------------------------------------------------------- 1 | * Add: [Inlined Markdown](snippets/markdown#inlined-markdown) plugin -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-06-code-reference-json.md: -------------------------------------------------------------------------------- 1 | * Add: JSON format for [Code References](snippets/code-references) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-09-json-enclose-in-object.md: -------------------------------------------------------------------------------- 1 | * Add: JSON [Enclose In Object](snippets/json#enclose-in-object) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-03-09-json-highlight-keys.md: -------------------------------------------------------------------------------- 1 | * Add: JSON [highlight keys](snippets/json#highlight-keys-by-path) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-07-03-json-callouts-file.md: -------------------------------------------------------------------------------- 1 | * Add: [JSON callouts from file](snippets/json#callouts-from-file) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/add-2023-12-15-charts-columns.md: -------------------------------------------------------------------------------- 1 | * Add [Charts columns](visuals/charts#filtering-columns) parameter 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-03-19-empty-doc-id.md: -------------------------------------------------------------------------------- 1 | * Add: Empty `--doc-id ""` support to deploy documentation to a site root -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-04-22-support-for-relative-url-with-dot.md: -------------------------------------------------------------------------------- 1 | * Add: Support `./dir/file-name.md` for markdown urls -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-04-23-markdown-image-fit-true.md: -------------------------------------------------------------------------------- 1 | * Add: default markdown image applies `fit:true` by default -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/add-2025-05-03-simplified-server-page-content-id.md: -------------------------------------------------------------------------------- 1 | * Add: Distinct `id` for HTML content for crawlers -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/fix-2025-04-27-markdown-image-fit-true.md: -------------------------------------------------------------------------------- 1 | * Fix: default markdown image applies `fit:true` by default -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.77/add-2025-07-07-ocaml-comments.md: -------------------------------------------------------------------------------- 1 | * Add: Extract [Ocaml comments](snippets/ocaml) as documentation text -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.78.1/fix-2025-08-26-ask-slack-url-with-slash.md: -------------------------------------------------------------------------------- 1 | * Fix: Add forward slash in generated url for ask-in-slack -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.78/add-2025-08-25-jupyter-include-section.md: -------------------------------------------------------------------------------- 1 | * Add: [Jupyter](snippets/jupyter-notebook) `includeSection` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/add-2025-10-12-search-for-plugins.md: -------------------------------------------------------------------------------- 1 | * Add: Search text for various plugins like `TextBadge` and `Latex` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.84/add-2025-11-23-search-highlights-improvements.md: -------------------------------------------------------------------------------- 1 | * Add: Remove search result highlights with Escape key -------------------------------------------------------------------------------- /znai-docs/znai/snippets/simple.c: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | using namespace std; 4 | 5 | int main() { 6 | cout << "hello"; 7 | } -------------------------------------------------------------------------------- /znai-docs/znai/visuals/screenshot1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/screenshot1.png -------------------------------------------------------------------------------- /znai-docs/znai/visuals/small-book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/small-book.png -------------------------------------------------------------------------------- /znai-java/src/test/resources/EnumMarkdown.java: -------------------------------------------------------------------------------- 1 | enum Enum { 2 | /** 3 | * description of **entry** 4 | */ 5 | ENTRY, 6 | } -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/doxygen.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-tests/src/test/groovy/doxygen.zip -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test-table-title-column.json: -------------------------------------------------------------------------------- 1 | [{"account": "#12BGD3", "title": "custom table with a long attachment"}] -------------------------------------------------------------------------------- /znai-core/src/test/resources/file-with-surround-marker.txt: -------------------------------------------------------------------------------- 1 | abc 2 | # concept-example 3 | foo() 4 | bar() 5 | # concept-example 6 | def -------------------------------------------------------------------------------- /znai-core/src/test/resources/file.txt: -------------------------------------------------------------------------------- 1 | this is a 2 | test file in 3 | a multiple lines 4 | line number 5 | --- stop 6 | and five 7 | and then six -------------------------------------------------------------------------------- /znai-dist/bin/znai-gen: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | CWD=`dirname "$0"` 3 | java -cp "$CWD/lib/*" org.testingisdocumenting.znai.gen.FromReadmeGenerator $* -------------------------------------------------------------------------------- /znai-docs/readme/znai-api-parameters.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-api-parameters.png -------------------------------------------------------------------------------- /znai-docs/readme/znai-external-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-external-code.png -------------------------------------------------------------------------------- /znai-docs/readme/znai-two-sides-tabs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/readme/znai-two-sides-tabs.png -------------------------------------------------------------------------------- /znai-docs/znai/configuration/basic.md: -------------------------------------------------------------------------------- 1 | # Favicon 2 | 3 | Put a `favicon.png` file inside the root of your docs (next to your `toc` file) 4 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.51/_fix-2021-07-03-flow-diagram-dash.md: -------------------------------------------------------------------------------- 1 | * Fix: handle dashes in [flow diagram](visuals/flow-diagrams) node ids -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-07-doxygen-comment.md: -------------------------------------------------------------------------------- 1 | * Add [doxygen docs](CPP/description-extraction) to embed comments text -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-02-15-validate-external-links.md: -------------------------------------------------------------------------------- 1 | * Add validate external links flag `--validate-external-links` 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/fix-2022-05-16-latex-render.md: -------------------------------------------------------------------------------- 1 | * Fix: [Latex](snippets/math) more complex math render by adding missing fonts -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-05-json-code-references.md: -------------------------------------------------------------------------------- 1 | * Add [JSON Code References](snippets/json#code-references) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-20-image-formal-parameters.md: -------------------------------------------------------------------------------- 1 | * Add formal plugin parameters to [Image Plugin](visuals/images) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-22-api-params-title.md: -------------------------------------------------------------------------------- 1 | * Tweak [API Parameters Title](snippets/api-parameters#title) style 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-22-api-params-wide.md: -------------------------------------------------------------------------------- 1 | * Add [API Parameters Wide Mode](snippets/api-parameters#wide-mode) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-22-image-zoom-color.md: -------------------------------------------------------------------------------- 1 | * Tweak [Image Zoom](visuals/images#fit) style in dark and light themes -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-02-mermaid-include.md: -------------------------------------------------------------------------------- 1 | * [Mermaid Diagrams External File](visuals/mermaid-diagrams#external-file) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-20-synergy-test.md: -------------------------------------------------------------------------------- 1 | * Doc: Improved Examples on [Synergy With Testing](synergy-with-testing/web-UI) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-22-image-zoom-scale.md: -------------------------------------------------------------------------------- 1 | * Fix: Enable [Image](visuals/images) click to zoom on scaled down images -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/add-2022-08-22-toc-panel-tooltip.md: -------------------------------------------------------------------------------- 1 | * Add tooltip to TOC items to display full title in case of overflow -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61/add-2022-09-23-table-wide-gap.md: -------------------------------------------------------------------------------- 1 | * Remove [Table](layout/tables) gap in [wide mode](layout/tables#wide-mode) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-11-01-table-wide-title-center.md: -------------------------------------------------------------------------------- 1 | * Add: Table [wide mode](layout/tables#wide-mode) centered title -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-12-01-javadoc-markdown.md: -------------------------------------------------------------------------------- 1 | * Add: JavaDoc [markdown support](java/description-extraction#markdown) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-12-09-plugin-defaults.md: -------------------------------------------------------------------------------- 1 | * Add: [Plugin Global Defaults](plugins/default-parameters#global-defaults) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/fix-2023-02-21-image-svg-null-pointer.md: -------------------------------------------------------------------------------- 1 | * Fix: [Images](visuals/images) null pointer when using with SVGs -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.69/fix-2024-04-30-presentation-viewport.md: -------------------------------------------------------------------------------- 1 | * Fix: Presentation mode viewport explicit width to force full screen -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.80/fix-2025-09-13-focus-page-content-on-load.md: -------------------------------------------------------------------------------- 1 | * Fix: Focus page content on page open or search open regression -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/add-2025-10-19-cli-title-override.md: -------------------------------------------------------------------------------- 1 | * Add: `ZNAI_APP_TITLE` to override cli output with custom tool title -------------------------------------------------------------------------------- /znai-docs/znai/visuals/idea-cropped.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/idea-cropped.png -------------------------------------------------------------------------------- /znai-docs/znai/visuals/regular-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/regular-image.png -------------------------------------------------------------------------------- /znai-docs/znai/visuals/word-toolbar.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/word-toolbar.jpg -------------------------------------------------------------------------------- /znai-reactjs/public/editor-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/editor-overview.png -------------------------------------------------------------------------------- /znai-reactjs/public/placeholder-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/placeholder-logo.png -------------------------------------------------------------------------------- /znai-sphinx/sphinx-sample-doc/chapter-two/page-five.rst: -------------------------------------------------------------------------------- 1 | Page Five Title 2 | =============== 3 | 4 | some more text here for page five 5 | 6 | -------------------------------------------------------------------------------- /znai-utils/src/test/resources/castle.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-utils/src/test/resources/castle.jpg -------------------------------------------------------------------------------- /znai-cli/src/main/resources/plugin-params.json: -------------------------------------------------------------------------------- 1 | { 2 | "api-parameters": { 3 | "title": "no title (set explicitly to override)" 4 | } 5 | } -------------------------------------------------------------------------------- /znai-core/src/test/resources/api-params-no-type.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "name": "firstName", 4 | "description": "first name" 5 | } 6 | ] 7 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/test.json: -------------------------------------------------------------------------------- 1 | { 2 | "key1": "value1", 3 | "key2": { 4 | "key21": "value21", 5 | "key22": "value22" 6 | } 7 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.51/add-2021-07-10-python-parsing.md: -------------------------------------------------------------------------------- 1 | * Python parsing is more robust and partially work with older versions of python -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.53/_fix-2021-09-08-python-data-classes.md: -------------------------------------------------------------------------------- 1 | * Fix: Parsing of Python data classes that include default field values 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/_fix-2021-12-24-ansi-background-fix.md: -------------------------------------------------------------------------------- 1 | * Fix: [CLI ANSI output](snippets/CLI#ansi-colors-output) background colors -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/doc-2021-12-01-what-is-this-revamp.md: -------------------------------------------------------------------------------- 1 | * Doc: rewrite of [What Is This](introduction/what-is-this) starting page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-03-27-partial-markdown.md: -------------------------------------------------------------------------------- 1 | * Added [include partial markdown](snippets/markdown#partial-markdown) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/fix-2022-02-01-search-special-chars.md: -------------------------------------------------------------------------------- 1 | * Fix: using `:`, `-`, `+` chars in **Search** doesn't lead to crash anymore -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-12-multi-bar-chart.md: -------------------------------------------------------------------------------- 1 | * Add multiple values per tick support to [Bar Chart](visuals/charts#bar) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-13-bar-chart-horizontal.md: -------------------------------------------------------------------------------- 1 | * [Bar Chart](visuals/charts#bar) horizontal mode with height setting 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/fix-2022-04-29-fix-search-preview-height.md: -------------------------------------------------------------------------------- 1 | * Fix: search preview popup has fixed height now to avoid size jump -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-05-30-wrong-cli-param-simpler-output.md: -------------------------------------------------------------------------------- 1 | * Better error message in case of wrong `znai` CLI argument name -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-04-json-path-highlight-color.md: -------------------------------------------------------------------------------- 1 | * More prominent colors for highlight of [JSON value](snippets/json) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-23-tooltip-comment-bullets.md: -------------------------------------------------------------------------------- 1 | * Add tooltip for [Code Comments Bullet Points](snippets/code-comments) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-02-graphviz-fence.md: -------------------------------------------------------------------------------- 1 | * Add Graphviz [fenced block](visuals/graphviz-diagrams#fenced-block) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-11-heading-style-in-menu.md: -------------------------------------------------------------------------------- 1 | * Reflect [Heading Style](visuals/headings) in Table Of Contents menu panel -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-06-22-image-pixel-ratio.md: -------------------------------------------------------------------------------- 1 | * Doc: Document [Image Pixel Ratio](visuals/image-annotations#pixel-ratio) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-28-incomplete-json.md: -------------------------------------------------------------------------------- 1 | * Doc: how to include [json that is not valid](snippets/json#incomplete-json) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-22-column-starts-with-link.md: -------------------------------------------------------------------------------- 1 | * Fix: [Column](layout/columns) rendering when content starts with a link -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/fix-2022-08-22-chapter-name-render-fix.md: -------------------------------------------------------------------------------- 1 | * Fix: next/prev page chapter name is properly rendered (was undefined) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-07-25-snippet-class-color.md: -------------------------------------------------------------------------------- 1 | * Add code snippets `class` color to be distinct from the regular text -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-08-15-charts-time.md: -------------------------------------------------------------------------------- 1 | * Add [Time Series](visuals/charts#time-series) option to [Charts](visuals/charts) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-08-23-attention-sign-block.md: -------------------------------------------------------------------------------- 1 | * Add: Attention Sign [Fence Block](visuals/attention-signs#fence-block) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-03-mobile-only-image.md: -------------------------------------------------------------------------------- 1 | * Add: Mobile and Desktop only [Images](visuals/images#mobile-and-desktop-only) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/add-2023-11-17-iframe-presentation.md: -------------------------------------------------------------------------------- 1 | * Add: [IFrame content](visuals/iframe) now participates in presentation mode -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.67/add-2024-01-22-tabs-shorten-lines.md: -------------------------------------------------------------------------------- 1 | * Add: Shorten [Tabs](layout/tabs) dividers when content inside is not wide -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.69/fix-2024-04-23-remove-title-quotes.md: -------------------------------------------------------------------------------- 1 | * Fix: Page [title overrides](flow/names) automatically removes quotes around -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/add-2024-07-09-code-snippet-better-search.md: -------------------------------------------------------------------------------- 1 | * Add: Search better recognizes dot separated code snippet entries -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/add-2024-09-07-search-highlight-improvement.md: -------------------------------------------------------------------------------- 1 | * Add: Improve [Search Result Preview](flow/search) highlighting -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/add-2024-11-09-preprocessor-new-line-support.md: -------------------------------------------------------------------------------- 1 | * Add: `preprocessor.csv` explicit new line support in replacement -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/fix-2024-11-08-search-custom-anchor.md: -------------------------------------------------------------------------------- 1 | * Fix: Search result section with custom anchor id no longer crash the page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/fix-2025-04-26-preview-server-kill.md: -------------------------------------------------------------------------------- 1 | * Fix: Exit the preview server when the initial documentation build fails -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.76/fix-2025-05-19-search-implicit-section.md: -------------------------------------------------------------------------------- 1 | * Fix: Local Search correctly previews content from an implicit section -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.79/add-2025-09-07-slack-persisted-questions.md: -------------------------------------------------------------------------------- 1 | * Add: Slack persisted questions 2 | * Add: Slack detached questions -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.79/fix-2025-08-31-ask-in-slack-bubble-height.md: -------------------------------------------------------------------------------- 1 | * Fix: Adjust position for ask in slack bubble with multiline text -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.80/fix-2025-09-08-ask-in-slack-index-page.md: -------------------------------------------------------------------------------- 1 | * Fix: Ask in Slack now generates a correct link for initial index page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81.1/fix-2025-10-21-jupyter-output-muliple-no-gap.md: -------------------------------------------------------------------------------- 1 | * Fix: Jupyter output multiple cell outputs use `noGap: true` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.82/add-2025-11-02-add-page-sections-to-llm-txt.md: -------------------------------------------------------------------------------- 1 | * Add: `llm.txt` now have links for each individual page section -------------------------------------------------------------------------------- /znai-docs/znai/snippets/schema-notes.csv: -------------------------------------------------------------------------------- 1 | root.store.bicycle.color, subject of **availability** 2 | root.store.bicycle.price, *price* changes daily -------------------------------------------------------------------------------- /znai-docs/znai/visuals/charts/time-series.csv: -------------------------------------------------------------------------------- 1 | day, RPG 2 | 2022-08-01, 100 3 | 2022-08-04, 50 4 | 2022-08-05, 10 5 | 2022-08-08, 5 6 | 2022-09-12, 22 -------------------------------------------------------------------------------- /znai-docs/znai/visuals/custom-components.md: -------------------------------------------------------------------------------- 1 | # React JS 2 | 3 | :include-reactjs-component: myComponents.CustomComponentA {title: "hello"} 4 | 5 | -------------------------------------------------------------------------------- /znai-docs/znai/visuals/editor-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/editor-overview.png -------------------------------------------------------------------------------- /znai-docs/znai/visuals/testingisdocumenting.csv: -------------------------------------------------------------------------------- 1 | rect,60,110,420,430,Note: zone description 2 | arrow,485,810,310,474,destination **description** 3 | -------------------------------------------------------------------------------- /znai-groovy/src/main/resources/sample.groovy: -------------------------------------------------------------------------------- 1 | println "hello" 2 | println "world" 3 | 4 | def "hello world"() { 5 | println "hello world" 6 | } -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/outside-chapter-file.md: -------------------------------------------------------------------------------- 1 | # File Outside 2 | 3 | Files don't have to belong to chapters if you have simple docs -------------------------------------------------------------------------------- /znai-core/src/test/resources/with-null.json: -------------------------------------------------------------------------------- 1 | { 2 | "key1": null, 3 | "key2": { 4 | "key21": "value21", 5 | "key22": "value22" 6 | } 7 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-29-cli-params-highlight.md: -------------------------------------------------------------------------------- 1 | * Rename `paramsToHighlight` -> `highlight` for `include-cli-command` plugin -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-06-15-python-function.md: -------------------------------------------------------------------------------- 1 | * Add [include-python](python/content-extraction) to include function's content 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/_fix-2021-08-03-table-title-scroll.md: -------------------------------------------------------------------------------- 1 | * Fix: Table [title](layout/tables#title) rendering when scroll is present 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/_fix-2021-11-22-enterprise-groups-authz.md: -------------------------------------------------------------------------------- 1 | * Fix: Enterprise nix based authz last user group is now taken into account -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-09-19-plugin-error-context.md: -------------------------------------------------------------------------------- 1 | * Add `include`, `fence` and `inline code` plugin failure context: id, params -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-10-doxygen-member-signature.md: -------------------------------------------------------------------------------- 1 | * Add [doxygen member signature](CPP/auto-reference#member-signature-only) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-02-09-fence-image.md: -------------------------------------------------------------------------------- 1 | * Add [image fence](visuals/image-annotations#badges) plugin with badge annotations 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/fix-2022-02-01-search-popup-size.md: -------------------------------------------------------------------------------- 1 | * Fix: search popup window height is consistent size when jumping between results -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/fix-2022-02-08-java-multiline-comment.md: -------------------------------------------------------------------------------- 1 | * Fix highlight code lines when multiline comment is present (e.g. `/* */`) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-04-landing-same-page-docs.md: -------------------------------------------------------------------------------- 1 | * Landing hub opens documentation in the same window and not a new tab 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-13-pie-echart.md: -------------------------------------------------------------------------------- 1 | * Migrate [Pie Chart](visuals/charts#pie) to [ECharts](https://echarts.apache.org/) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-20-json-collapsed-paths-validation.md: -------------------------------------------------------------------------------- 1 | * Add [JSON Collapsed Paths](snippets/json#hidden-parts) validation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-22-api-params-params.md: -------------------------------------------------------------------------------- 1 | * Add [API Parameters](snippets/api-parameters) plugin parameters definition 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-01-mermaid-dark-theme.md: -------------------------------------------------------------------------------- 1 | * [Mermaid Diagrams](visuals/mermaid-diagrams) dark mode and auto them switch -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-16-image-annotation-csv.md: -------------------------------------------------------------------------------- 1 | * Image Annotation [From CSV File](visuals/image-annotations#annotations-file) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-16-markdowns-sort.md: -------------------------------------------------------------------------------- 1 | * Add [include-markdowns](snippets/markdown#multiple-markdown-files) `sort` parameter -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-18-image-annot-json-color.md: -------------------------------------------------------------------------------- 1 | * Add [Auto Annotation Color](visuals/image-annotations) for JSON annotations -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-07-25-chapter-title-override.md: -------------------------------------------------------------------------------- 1 | * Add [Chapter Title Override](flow/names#chapter-names) via `toc` file -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-01-compact-rename.md: -------------------------------------------------------------------------------- 1 | * Rename: `compact` property is now [noGap](snippets/external-code-snippets#no-gap) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-07-21-snippet-anchor-no-file.md: -------------------------------------------------------------------------------- 1 | * Add: [Anchor](snippets/code-snippets#anchor) support for embedded code blocks -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/doc-2023-09-10-testing-page-tweaks.md: -------------------------------------------------------------------------------- 1 | * Doc: [Testing Is Documenting](flow/testing-is-documenting) intro page rework -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/fix-2023-09-04-links-from-index.md: -------------------------------------------------------------------------------- 1 | * Fix: Links from `index` page are no longer always pointing to index page itself -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/add-2023-12-07-iframe-auto-reload.md: -------------------------------------------------------------------------------- 1 | * Add: [IFrame](visuals/iframe) auto reload on html content change during preview -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-03-14-doxygen-member-presentation.md: -------------------------------------------------------------------------------- 1 | * Add: Presentation mode handling for [Doxygen](CPP/doxygen-setup) members -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.69/fix-2024-04-30-auto-title-with-custom-ext.md: -------------------------------------------------------------------------------- 1 | * Fix: [auto title](flow/names) now correctly ignores specified extension. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/add-2024-09-10-search-wildcard.md: -------------------------------------------------------------------------------- 1 | * Add: [Search Result Preview](flow/search) wildcard and stronger boost to page titles -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-11-02-graphviz-color-fix.md: -------------------------------------------------------------------------------- 1 | * Add: [Graphviz](visuals/graphviz-diagrams) better black color support in subgraph -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/fix-2024-11-09-ignore-html-comment.md: -------------------------------------------------------------------------------- 1 | * Fix: html comment block when used before first no longer creates extra spacing -------------------------------------------------------------------------------- /znai-docs/znai/snippets/file-name.js: -------------------------------------------------------------------------------- 1 | class JsClass { 2 | constructor() { 3 | usefulAction() 4 | } 5 | } 6 | 7 | export default JsClass -------------------------------------------------------------------------------- /znai-docs/znai/snippets/jupyter/notebook.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/snippets/jupyter/notebook.png -------------------------------------------------------------------------------- /znai-docs/znai/synergy-with-testing/test.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/synergy-with-testing/test.png -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/toc: -------------------------------------------------------------------------------- 1 | outside-chapter-file.md 2 | chapter-one 3 | links 4 | target 5 | chapter-two 6 | doxygen-from-zip -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/dummy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-website-gen/src/test/resources/dummy.png -------------------------------------------------------------------------------- /znai-core/src/test/resources/images/png-test.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-core/src/test/resources/images/png-test.png -------------------------------------------------------------------------------- /znai-core/src/test/resources/script.groovy: -------------------------------------------------------------------------------- 1 | import e.d.g.AnotherName 2 | import a.b.c.ClassName 3 | 4 | class HelloWorld { 5 | def a 6 | int b 7 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.51/add-2021-07-11-py-doc-params.md: -------------------------------------------------------------------------------- 1 | * Added initial [pythod doc params](python/description-extraction#doc-parameters) support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/_fix-2021-10-30-note-icons-alignment.md: -------------------------------------------------------------------------------- 1 | * Fix: icon alignment regression in [Attention Paragraphs](visuals/attention-signs) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/doc-2021-12-22-snippet-manipulation.md: -------------------------------------------------------------------------------- 1 | * Doc: moved [Snippets Manipulation](snippets/snippets-manipulation) to its own page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-13-line-echart.md: -------------------------------------------------------------------------------- 1 | * Migrate [Line Chart](visuals/charts#line) to [ECharts](https://echarts.apache.org/) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-14-remove-chart-plugin.md: -------------------------------------------------------------------------------- 1 | * Remove generic `include-chart` plugin that uses Victory Chart for rendering 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-01-readmore-collapse.md: -------------------------------------------------------------------------------- 1 | * Add collapse button for [Snippet Read More](snippets/external-code-snippets#read-more) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-12-python-doc-returns.md: -------------------------------------------------------------------------------- 1 | * Parse [Python Returns](python/description-extraction#doc-parameters) PyDoc section -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-07-08-lookup-paths-classpath-fix.md: -------------------------------------------------------------------------------- 1 | * Doc: fix example of [classpath lookup](flow/lookup-paths#class-path-lookup) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-08-highlight-all-matches.md: -------------------------------------------------------------------------------- 1 | * Add: [highlight by text](snippets/snippets-highlighting) highlights all matches -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61/fix-2022-09-27-java-anchor-id.md: -------------------------------------------------------------------------------- 1 | * Fix: [Java Anchor](java/content-extraction#anchor) linking from pages incorrect validation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/fix-2023-02-08-table-params-conflict.md: -------------------------------------------------------------------------------- 1 | * Fix: Table column parameters [name conflict](layout/tables#column-names-conflict) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-07-25-surrounded-by-keep.md: -------------------------------------------------------------------------------- 1 | * Add: [surroundedByKeep](snippets/snippets-manipulation#surrounded-by) boolean option -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/fix-2024-04-04-json-presentation-mode-fix.md: -------------------------------------------------------------------------------- 1 | * Fix: [Json](snippets/json) presentation mode correctly highlights value nodes -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.69/fix-2024-04-16-index-lookup.md: -------------------------------------------------------------------------------- 1 | * Fix: documentation root index.md file is detected again (instead of automatic redirection) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/add-2024-08-21-latex-inline-margin-tweaks.md: -------------------------------------------------------------------------------- 1 | * Add: Adjust inlined [Latex](snippets/math#latex-inline) horizontal spacing -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/add-2024-09-17-search-snippets-high-score.md: -------------------------------------------------------------------------------- 1 | * Add: [Search Result Preview](flow/search) code snippets have higher weight -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-11-03-snippet-strip-indent.md: -------------------------------------------------------------------------------- 1 | * Add: [Code Snippets](snippets/code-snippets) automatically strip extra indentation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/add-2024-11-08-top-header-current-toc.md: -------------------------------------------------------------------------------- 1 | * Add: [Top Header](configuration/top-header) displays current chapter/page/section -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.78/add-2025-08-24-selected-text-menu.md: -------------------------------------------------------------------------------- 1 | * Add: Initial menu for selected text. Generate link with comment and send to slack. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.82/add-2025-11-02-search-entries-xml.md: -------------------------------------------------------------------------------- 1 | * Add: `search-entries.xml` now contains page section text as markdown representation -------------------------------------------------------------------------------- /znai-docs/znai/snippets/jupyter/games.csv: -------------------------------------------------------------------------------- 1 | genre,title,price 2 | RPG,Witcher 3,20.0 3 | FPS,Doom,39.0 4 | Strategy, War Craft,10.0 5 | Cards, Balatro,5.0 6 | -------------------------------------------------------------------------------- /znai-docs/znai/visuals/flow-diagrams/graph-using-lib.json: -------------------------------------------------------------------------------- 1 | { 2 | "edges": [ 3 | ["a1", "a2"], 4 | ["b1", "b2"], 5 | ["b1", "a2"] 6 | ] 7 | } -------------------------------------------------------------------------------- /znai-docs/znai/visuals/testingisdocumenting.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-docs/znai/visuals/testingisdocumenting.png -------------------------------------------------------------------------------- /znai-reactjs/public/static/fonts/Lato-Bold.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/static/fonts/Lato-Bold.woff2 -------------------------------------------------------------------------------- /znai-website-gen/src/main/resources/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-website-gen/src/main/resources/favicon.png -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test-table.csv: -------------------------------------------------------------------------------- 1 | Account, Price, Description 2 | #12BGD3, 100, custom table with a long attachment 3 | #12BGD3, 150, chair -------------------------------------------------------------------------------- /znai-docs/znai/configuration/top-header.md: -------------------------------------------------------------------------------- 1 | To enable Top Header navigation bar, add `useTopHeader` to `meta.json`: 2 | 3 | ``` 4 | "useTopHeader": true 5 | ``` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/doc-2021-05-23-getting-started-clarify.md: -------------------------------------------------------------------------------- 1 | * Doc: clarify [Getting Started](introduction/getting-started) documentation section -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.53/add-2021-09-12-image-annotations-fit.md: -------------------------------------------------------------------------------- 1 | * Fix [Image Annotations](visuals/image-annotations) placement when `fit: true` is present -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-17-doxygen-member-args-selection.md: -------------------------------------------------------------------------------- 1 | * Add Doxygen member [select by args](CPP/auto-reference#all-matching-signatures) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/add-2021-12-31-section-title-badge.md: -------------------------------------------------------------------------------- 1 | * Extra spacing between section title and [its badge](visuals/text-badge#part-of-heading) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-15-chart-presentation.md: -------------------------------------------------------------------------------- 1 | * Add presentation support for [Line Chart](visuals/charts#presentation) breakpoints 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-16-external-images.md: -------------------------------------------------------------------------------- 1 | * Add [External Images](visuals/images#external-image) support and image URL validation 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-18-steps-bullets-align.md: -------------------------------------------------------------------------------- 1 | * Add [Smart Bullets Points Steps](visuals/smart-bullet-points#steps) align option 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/fix-2022-05-18-table-text-selection-preview.md: -------------------------------------------------------------------------------- 1 | * Fix: [Table](layout/tables) text selection during preview is not auto deselected -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-15-badges-fence-auto-color.md: -------------------------------------------------------------------------------- 1 | * Add [Image Badge Annotation](visuals/image-annotations#badges) auto color detection -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-04-python-doc-type-hints.md: -------------------------------------------------------------------------------- 1 | * Add Python Doc params [Type Hint support](python/description-extraction#type-hints) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-14-image-arrow-rect-tooltip.md: -------------------------------------------------------------------------------- 1 | * Add [Rectangles And Arrows](visuals/image-annotations#rectangles-and-arrows) Tooltips -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/doc-2022-06-20-what-is-this.md: -------------------------------------------------------------------------------- 1 | * Doc: Rework [What Is This](introduction/what-is-this) with more examples and reorganized order -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-07-27-standard-image-title.md: -------------------------------------------------------------------------------- 1 | * Add title support for [Standard Markdown Image](visuals/images#standard-markdown) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/fix-2022-07-22-image-zoom-vertical-scroll.md: -------------------------------------------------------------------------------- 1 | * Fix: [Image Zoom](visuals/images#fit) now has vertical scroll for tall images -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-08-24-external-code-snippet-anchor.md: -------------------------------------------------------------------------------- 1 | * Add: [External Snippet Anchor](snippets/external-code-snippets#my-code-anchor) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61.2/fix-2022-10-19-card-auxiliary-file.md: -------------------------------------------------------------------------------- 1 | * Fix: [Card](visuals/cards) recognizes additional images inside to include into dist. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-12-10-plugin-page-local-defaults.md: -------------------------------------------------------------------------------- 1 | * Add: [Plugin Page Local Defaults](plugins/default-parameters#page-local-defaults) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-08-17-highlights-region-single.md: -------------------------------------------------------------------------------- 1 | * Add: code snippets [highlighting regions](snippets/snippets-highlighting#region) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-08-24-yellow-ansi-tweaks.md: -------------------------------------------------------------------------------- 1 | * Add: tweak yellow [terminal output](snippets/CLI#output-highlight) color for light theme -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/doc-2023-08-21-snippets-highlight-page.md: -------------------------------------------------------------------------------- 1 | * Doc: Move snippets highlighting into [its own page](snippets/snippets-highlighting) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/fix-2023-02-28-code-constant-color.md: -------------------------------------------------------------------------------- 1 | * Fix: [snippets](snippets/external-code-snippets) constant color for dark and light theme -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/fix-2023-09-05-footer-images.md: -------------------------------------------------------------------------------- 1 | * Fix: Deploy images that are used in [Footer](https://testingisdocumenting.org/znai/flow/footer) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.65/fix-2023-09-25-iframe-restore-focus.md: -------------------------------------------------------------------------------- 1 | * Fix: Restore search focus when [iframe](visuals/iframe) is present in search preview -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-03-27-api-params-presentation.md: -------------------------------------------------------------------------------- 1 | * Add: Presentation mode handling for [API Parameters](snippets/api-parameters) members -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.70/add-2024-06-06-upload-resource-locator.md: -------------------------------------------------------------------------------- 1 | * Add: Use `lookup-paths` to find files from [upload.txt](deployment/additional-files) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/add-2024-11-09-footnote-preview-fixed-width.md: -------------------------------------------------------------------------------- 1 | * Add: [Footnote preview](flow/footnotes) uses fixed width to match content width -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/add-2024-11-09-graphviz-colors.md: -------------------------------------------------------------------------------- 1 | * Add: [Graphviz](visuals/graphviz-diagrams) expose hex colors for override via css variables -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-02-25-preview-reduce-output-details.md: -------------------------------------------------------------------------------- 1 | * Add: Preview server prints less details of what is being sent to the browser -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-04-23-toc-links-in-every-page.md: -------------------------------------------------------------------------------- 1 | * Add: generate TOC as simplified server side rendering for every page for crawlers. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/fix-2025-05-03-preview-same-file-name-clash.md: -------------------------------------------------------------------------------- 1 | * Fix: changing files with the same name in preview mode is no longer confuse files -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.82/add-2025-11-02-slack-offline-indicator.md: -------------------------------------------------------------------------------- 1 | * Add: Dismissable slack offline indicator instead of an error banner on every page. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.84/add-2025-12-07-tracking-http-end-point.md: -------------------------------------------------------------------------------- 1 | * Add: Custom HTTP tracking endpoint via `ZNAI_TRACK_ACTIVITY_URL` environemnt variable -------------------------------------------------------------------------------- /znai-docs/znai/snippets/custom.dsl: -------------------------------------------------------------------------------- 1 | block-A-start: 2 | event-one-handler: 3 | ... 4 | block-A-end 5 | 6 | block-B-start 7 | ... 8 | block-B-end 9 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/references/json-references-demo.csv: -------------------------------------------------------------------------------- 1 | trader, example-references/domain#trader 2 | transaction, example-references/domain#transaction 3 | -------------------------------------------------------------------------------- /znai-docs/znai/visuals/charts/competitors.csv: -------------------------------------------------------------------------------- 1 | x, company one, company two 2 | 10, 100, 150 3 | 15.5, 110, 145 4 | 30, 120, 130 5 | 40, 110, 145 6 | 50, 115, 100 -------------------------------------------------------------------------------- /znai-reactjs/public/static/fonts/Lato-Black.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/static/fonts/Lato-Black.woff2 -------------------------------------------------------------------------------- /znai-reactjs/public/static/fonts/Lato-Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/static/fonts/Lato-Italic.woff2 -------------------------------------------------------------------------------- /znai-reactjs/public/static/fonts/Lato-Light.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/static/fonts/Lato-Light.woff2 -------------------------------------------------------------------------------- /znai-reactjs/public/static/fonts/Lato-Regular.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/static/fonts/Lato-Regular.woff2 -------------------------------------------------------------------------------- /znai-ddjt-docs/ddjt/introduction/getting-started.md: -------------------------------------------------------------------------------- 1 | # VATS 2 | 3 | * Add dependency on `ts_ddjt` 4 | * `import static org.testingisdocumenting.testing.Ddjt.*` 5 | -------------------------------------------------------------------------------- /znai-docs/znai/layout/table/table-conflict.csv: -------------------------------------------------------------------------------- 1 | account, title 2 | #12BGD3, custom table with a long attachment 3 | #12BGD4, custom table with a short attachment 4 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-06-16-img-annotation-badge-transparent.md: -------------------------------------------------------------------------------- 1 | * [Image badge annotation](visuals/image-annotations) becomes transparent on hover -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-14-javadoc-field-ambig.md: -------------------------------------------------------------------------------- 1 | * Add [inner classes](java/description-extraction#inner-classes) reference to java doc parsing -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-17-doxygen-all-signatures-at-once.md: -------------------------------------------------------------------------------- 1 | * Add [doxygen all overloads at once](CPP/auto-reference#specific-member-by-args) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/add-2021-12-30-doxygen-args-normalize.md: -------------------------------------------------------------------------------- 1 | * Normalize doxygen member [selection by args](CPP/auto-reference#specific-member-by-args) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-20-api-params-validation.md: -------------------------------------------------------------------------------- 1 | * Better validation of [API Parameters](snippets/api-parameters#external-json-file) input JSON -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-23-charts-pie-presentation.md: -------------------------------------------------------------------------------- 1 | * Add [Pie Chart](visuals/charts#presentation) presentation mode breakpoints support 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-24-charts-bar-presentation.md: -------------------------------------------------------------------------------- 1 | * Add [Bar Chart](visuals/charts#presentation) presentation mode breakpoints support 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-25-lookup-paths-cli-rework.md: -------------------------------------------------------------------------------- 1 | * Use standard args parsing for [CLI Lookup Paths](flow/lookup-paths#cli-parameter) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-14-image-arrow-rect.md: -------------------------------------------------------------------------------- 1 | * Add [Rectangles And Arrows](visuals/image-annotations#rectangles-and-arrows) image annotations -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-06-16-image-scale-annotations.md: -------------------------------------------------------------------------------- 1 | * Fix: Image explicit `scale` now respects [Annotations Placement](visuals/image-annotations) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/fix-2022-07-19-maven-delete-on-exit.md: -------------------------------------------------------------------------------- 1 | * Fix: Maven Plugin race condition between shutdown hook and apache FileUtils class unload -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-08-11-relative-links.md: -------------------------------------------------------------------------------- 1 | * Add: Support for [limited relative links](flow/page-references#links) with explicit file extension -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-08-19-highlights-region-scope.md: -------------------------------------------------------------------------------- 1 | * Add: code snippets [highlighting regions scope](snippets/snippets-highlighting#region) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/fix-2023-02-28-presentation-bullet-list-grid.md: -------------------------------------------------------------------------------- 1 | * Fix: `Grid` bullet list presentation mode is now properly hiding unrevealed boxes -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.67/add-2024-01-06-rename-snippet-no-gap-separator.md: -------------------------------------------------------------------------------- 1 | * Rename: `noGapSeparator` to [noGapBorder](snippets/external-code-snippets#no-gap) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.67/add-2024-01-16-preview-anchor.md: -------------------------------------------------------------------------------- 1 | * Add: automatic preview navigation to the most recent change ignores previous user clicked anchors -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.70/fix-2024-06-04-doxygen-members-empty-declname.md: -------------------------------------------------------------------------------- 1 | * Fix: [Doxygen](CPP/doxygen-setup) now handles empty `declname` in method parameters -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.72/add-2024-10-02-iframe-max-height.md: -------------------------------------------------------------------------------- 1 | * Add: [iframe](visuals/iframe) `maxHeight` to add scrollbars that match in style the main document -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.78.1/fix-2025-08-26-remove-ask-in-slack-content-type.md: -------------------------------------------------------------------------------- 1 | * Fix: Remove ask-in-slack `content-type` from `POST` request to simplify CORS -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.79/add-2025-08-31-index-pages-for-chapters.md: -------------------------------------------------------------------------------- 1 | * Add: Generate index.html files for chapters to automatically redirect to the first page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/add-2025-10-20-llm-page-urls.md: -------------------------------------------------------------------------------- 1 | * Add: `llm.txt` now contains urls to the pages. Set custom prefix using `ZNAI_LLM_URL_PREFIX` env var -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.84/fix-2025-11-23-search-highlights-improvements.md: -------------------------------------------------------------------------------- 1 | * Fix: Search highlights apply highlights when user is already on the resulting page. -------------------------------------------------------------------------------- /znai-docs/znai/snippets/faq-collection/2022-07-15-preview.md: -------------------------------------------------------------------------------- 1 | ### How to run preview mode? 2 | 3 | To run Znai in preview mode 4 | 5 | ```cli 6 | znai preview 7 | ``` -------------------------------------------------------------------------------- /znai-server/src/main/java/org/testingisdocumenting/znai/server/requests.http: -------------------------------------------------------------------------------- 1 | GET http://localhost:3333/znai 2 | Authorization: Basic dGVzdHVzZXIgZHVtbXlwYXNzd29yZA== -------------------------------------------------------------------------------- /znai-core/src/test/resources/api-params-simple.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "name": "firstName", 4 | "type": "String", 5 | "description": "first name" 6 | } 7 | ] 8 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/_fix-2021-06-06-columns-snippet.md: -------------------------------------------------------------------------------- 1 | * Fix: extra margin in *Columns Layout* when code snippets in both columns goes after a code snippet -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-08-14-py-doc-params-dash.md: -------------------------------------------------------------------------------- 1 | * Handle dash (`----`) for [python doc params](python/description-extraction#doc-parameters) parsing -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-16-doxygen-compound.md: -------------------------------------------------------------------------------- 1 | * Add [doxygen compound](CPP/auto-reference#compound) to include class description and methods/attributes -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-03-22-groovy-multiple-body-only.md: -------------------------------------------------------------------------------- 1 | * Added [multiple bodies only](snippets/groovy#multiple-bodies) using `entry` for Groovy 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/fix-2022-05-10-code-snippet-columns.md: -------------------------------------------------------------------------------- 1 | * Fix: remove extra top margin in case of code snippet in between code snippets in two columns mode -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-07-image-collapse-no-gap.md: -------------------------------------------------------------------------------- 1 | * Add: Image [Collapse](visuals/images#collapse) 2 | * Add: Image [No Gap](visuals/images#no-gap) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-05-cli-command-visuals.md: -------------------------------------------------------------------------------- 1 | * Add: better alignment of multiple [CLI Commands](snippets/CLI) in a row and when surrounded by text -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-08-15-highlights-next-prev.md: -------------------------------------------------------------------------------- 1 | * Add: Improve [highlighting](snippets/snippets-highlighting) of adjacent lines in code snippets -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-09-18-preview-toc-items-outside.md: -------------------------------------------------------------------------------- 1 | * Add: Preview and real time updates for TOC items that are outside main documentation directory -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-09-24-iframe-fit.md: -------------------------------------------------------------------------------- 1 | * Add: [iframe fit parameter](visuals/iframe#embedding-supporting-content) to auto adjust height of the iframe -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.65/add-2023-10-05-surrounded-by-scope.md: -------------------------------------------------------------------------------- 1 | * Add: [Surrounded By Scope](snippets/snippets-manipulation#surrounded-by-scope) text manipulation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/fix-2024-11-08-section-tracking-custom-anchor.md: -------------------------------------------------------------------------------- 1 | * Fix: Correctly highlight page sections with custom anchor id as you scroll through a page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/fix-2024-11-09-search-file-gen-ansi-cleaner.md: -------------------------------------------------------------------------------- 1 | * Fix: Remove more non printable characters when creating global search index to avoid crash -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.76/add-2025-05-19-hide-presentation-trigger.md: -------------------------------------------------------------------------------- 1 | * Add: new option `hidePresentationTrigger` to `meta.json` to hide presentation trigger icons. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.79/add-2025-09-07-jupyter-table-style-tweaks.md: -------------------------------------------------------------------------------- 1 | * Fix: Slack link - remove trailing slash from `questionId` to fix auto scroll to the question -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.83/fix-2025-11-08-add-new-file-toc.md: -------------------------------------------------------------------------------- 1 | * Fix: When new page is added to `toc`, deploy `all-pages.json` to have added pages loaded on page reload -------------------------------------------------------------------------------- /znai-docs/znai/snippets/schema-notes.json: -------------------------------------------------------------------------------- 1 | { 2 | "root.store.bicycle.color": "subject of **availability**", 3 | "root.store.bicycle.price": "*price* changes daily" 4 | } -------------------------------------------------------------------------------- /znai-reactjs/README.md: -------------------------------------------------------------------------------- 1 | # Local Dev 2 | 3 | ``` 4 | npm start 5 | ``` 6 | 7 | Optionally start znai documentation preview server to help with end to end manual testing -------------------------------------------------------------------------------- /znai-reactjs/public/static/fonts/Lato-BoldItalic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/static/fonts/Lato-BoldItalic.woff2 -------------------------------------------------------------------------------- /znai-reactjs/public/static/fonts/Lato-LightItalic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-reactjs/public/static/fonts/Lato-LightItalic.woff2 -------------------------------------------------------------------------------- /znai-docs/znai/introduction/example.json: -------------------------------------------------------------------------------- 1 | { 2 | "person": { 3 | "id": "pid1", 4 | "name": "Person Name" 5 | }, 6 | "details": { 7 | "extra": "info" 8 | } 9 | } -------------------------------------------------------------------------------- /znai-docs/znai/layout/table-markup.csv: -------------------------------------------------------------------------------- 1 | Account, Price, Description 2 | #12BGD3, 100, **custom** table with a long attachment 3 | #12BGD3, 150, chair 4 | #91AGB1, 10, `lunch` 5 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-16-surrounded-by.md: -------------------------------------------------------------------------------- 1 | * Add `surroundedB` to include-file like plugins: [documentaiton](snippets/snippets-manipulation#surrounded-by) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-07-12-py-vars.md: -------------------------------------------------------------------------------- 1 | * Add support for variables to [include-python](python/content-extraction) and revamped the entire doc section 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-09-04-api-params-style-tweaks.md: -------------------------------------------------------------------------------- 1 | * Force max width for type and name for [API Parameters](snippets/api-parameters). Reduce title height. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-22-doxygen-ignore-template-param.md: -------------------------------------------------------------------------------- 1 | * Add Doxygen [ignore template parameter](CPP/description-extraction#ignore-template-parameters) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/add-2021-12-22-surrounded-by-multiple.md: -------------------------------------------------------------------------------- 1 | * Add [Surrounded By Multiple](snippets/snippets-manipulation#multiple-surrounded-by) blocks support -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-03-21-java-multiple-body-only.md: -------------------------------------------------------------------------------- 1 | * Added [multiple bodies only](java/content-extraction#multiple-bodies) using `entry` for Java 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/fix-2022-08-21-api-params-empty-names.md: -------------------------------------------------------------------------------- 1 | * Fix: remove possible duplication of [API Parameters](snippets/api-parameters) when param names match -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-08-05-api-params-expand-when-only.md: -------------------------------------------------------------------------------- 1 | * [API Parameters](snippets/api-parameters) expand nested by default when single root parameter -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/fix-2022-12-25-snippet-last-api-parameters-gap.md: -------------------------------------------------------------------------------- 1 | * Fix: remove extra gap from last code snippet inside [API parameters](snippets/api-parameters) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.69/add-2024-05-06-initial-inline-code-in-header.md: -------------------------------------------------------------------------------- 1 | * Add: Initial support for `inlined-code` in headers. For now it displays it as a regular text. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.78/add-2025-07-13-pages-without-chapter.md: -------------------------------------------------------------------------------- 1 | * Add: Initial support for [pages defined outside of chapters](flow/structure#pages-without-chapters) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.83/fix-2025-11-16-llm-text-selection-triple-click.md: -------------------------------------------------------------------------------- 1 | * Fix: Ask In Slack and Generate Link are now working for paragraphs selected with triple click -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.84/fix-2025-12-06-ocaml-comments-fix-indentation.md: -------------------------------------------------------------------------------- 1 | * Fix: `:include-ocaml-comment:` properly strips indentations instead of creating a code block -------------------------------------------------------------------------------- /znai-docs/znai/snippets/markdown-dir/md-to-include.md: -------------------------------------------------------------------------------- 1 | # Included Markdown 2 | 3 | This markdown, and the sub-heading above, were included using the `include-markdown` plugin. -------------------------------------------------------------------------------- /znai-core/src/test/resources/file-with-empty-lines.txt: -------------------------------------------------------------------------------- 1 | 2 | this is a 3 | 4 | a multiple lines 5 | 6 | line number 7 | --- stop 8 | and five 9 | 10 | and then six 11 | -------------------------------------------------------------------------------- /znai-ddjt-docs/ddjt/index.md: -------------------------------------------------------------------------------- 1 | # DDJT 2 | 3 | Data Driven Java Testing: Java and Groovy API to write data driven Unit/Component/Integration tests test your JVM based Applications. 4 | -------------------------------------------------------------------------------- /znai-docs/znai/layout/instructions/cpp-install.md: -------------------------------------------------------------------------------- 1 | First you need to download CLion and then run the following using your terminal 2 | 3 | $ pwd 4 | $ whoami 5 | 6 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-09-snippet-extra-validation.md: -------------------------------------------------------------------------------- 1 | * Validate that [snippets include/exclude](snippets/snippets-manipulation#include-regexp) matches lines -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-08-24-py-doc-params-optional-type.md: -------------------------------------------------------------------------------- 1 | * Handle optional type during [python doc params](python/description-extraction#doc-parameters) parsing -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-09-25-plugin-params-parse-error-context.md: -------------------------------------------------------------------------------- 1 | * Plugin parameters parsing error provides more details about plugin id and provided parameters -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-10-20-comments-type-remove.md: -------------------------------------------------------------------------------- 1 | * Add [commentsType: remove](snippets/code-comments#remove-comments) to remove comments from a code snippet -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-30-image-annotation-coordinates.md: -------------------------------------------------------------------------------- 1 | * [Image Annotation Coordinates](visuals/image-annotations#manual-coordinates) during preview mode -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/fix-2022-07-24-image-horizontal-scroll-cut.md: -------------------------------------------------------------------------------- 1 | * Fix: Centered [Image](visuals/images) with horizontal scrollbar doesn't cut parts of image anymore -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61.1/add-2022-10-05-image-annotation-report-outside.md: -------------------------------------------------------------------------------- 1 | * Add: Report [Image Annotations](visuals/image-annotations) that are outside of image boundaries -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/fix-2022-11-25-graphviz-multiline-fix.md: -------------------------------------------------------------------------------- 1 | * Fix: Flow Diagrams [multi line](visuals/flow-diagrams#multiline-labels) support when color or shape is set -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-16-openapi-summary-validation-auto-section.md: -------------------------------------------------------------------------------- 1 | * Add: [Open API](snippets/open-API) summary field validation when using `autoSection: true` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-09-19-md-preprocessor.md: -------------------------------------------------------------------------------- 1 | * Add: regexp based preprocessor to modify markdown files before parsing (to work with existing custom markdowns) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/fix-2023-12-14-console-output-leading-spaces.md: -------------------------------------------------------------------------------- 1 | * Fix: Properly render leading spaces when using [include-cli-output](snippets/CLI#ansi-colors-output) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.77/add-2025-07-04-footnote-force-index.md: -------------------------------------------------------------------------------- 1 | * Add: [Footnote](flow/footnotes) uses given label instead of auto incrementing index if the label is numeric -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/fix-2025-10-19-global-search-entries-comma.md: -------------------------------------------------------------------------------- 1 | * Fix: `/search-entries.xml` correctly constructs `title` field when text is outside a top level header -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/image-darkness-ratio.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-website-gen/src/test/resources/image-darkness-ratio.png -------------------------------------------------------------------------------- /znai-docs/znai/layout/artifacts/generated-values.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "specified name", 3 | "code": "class CodeSnippet {\n ...\n}", 4 | "description": "generated description" 5 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.52/add-2021-08-25-py-doc-exclude-params-from-desc.md: -------------------------------------------------------------------------------- 1 | * Exclude Parameters section type during [python doc](python/description-extraction#doc-string) parsing -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-04-20-surrounded-by-null-separator.md: -------------------------------------------------------------------------------- 1 | * Add [surrounded by null](snippets/snippets-manipulation#multiple-surrounded-by) as separator value 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-27-image-annotation-arrow-style.md: -------------------------------------------------------------------------------- 1 | * Change `arrow` [Image Annotations](visuals/image-annotations) style to be single color and use tooltip -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-10-python-class-def.md: -------------------------------------------------------------------------------- 1 | * Add [include-python-class: package.ClassName](python/auto-reference#class-definition) to display and define a class -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-08-10-snippet-compact.md: -------------------------------------------------------------------------------- 1 | * Add [compact](snippets/external-code-snippets#no-gap) option to [Code Snippets](snippets/external-code-snippets) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-09-12-surrounded-by-message.md: -------------------------------------------------------------------------------- 1 | * Add: Clarify [Surrounded By](snippets/snippets-manipulation#surrounded-by) message when second marker is absent -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.65/add-2023-09-25-iframe-index-html.md: -------------------------------------------------------------------------------- 1 | * Add: Automatically add index.html if [iframe](visuals/iframe) src points to documentation content and ends with `/` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-04-15-redirect-use-absolute-url.md: -------------------------------------------------------------------------------- 1 | * Add: `include-redirect` plugin converts passed `url` to full absolute URL to better support `docId` with `/` -------------------------------------------------------------------------------- /znai-docs/znai/snippets/faq-collection/2022-07-14-install.md: -------------------------------------------------------------------------------- 1 | ### How to install Znai? 2 | 3 | To install Znai use 4 | 5 | ```cli 6 | brew install testingisdocumenting/brew/znai 7 | ``` -------------------------------------------------------------------------------- /znai-docs/znai/visuals/charts/daily-genres.csv: -------------------------------------------------------------------------------- 1 | day, RPG, RTS, FPS 2 | Monday, 100, 10, 0 3 | Tuesday, 50, 50, 20 4 | Wednesday, 10, 30, 50 5 | Thursday, 5, 5, 100 6 | Friday, 0, 100, 10 -------------------------------------------------------------------------------- /znai-docs/znai/visuals/charts/game-activities.csv: -------------------------------------------------------------------------------- 1 | game, walking, fighting, reading 2 | Oblivion, 100, 100, 20 3 | Elden Ring, 110, 110, 5 4 | Persona 5, 20, 30, 50 5 | Divinity, 30, 30, 10 -------------------------------------------------------------------------------- /znai-website-gen/src/main/resources/static/favicon/default.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/testingisdocumenting/znai/HEAD/znai-website-gen/src/main/resources/static/favicon/default.png -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.53/_fix-2021-09-13-pydoc-assignment-parse-fix.md: -------------------------------------------------------------------------------- 1 | * Fix [python variable extraction](python/content-extraction) crashing in certain cases by adding more checks 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/fix-2022-05-18-read-more-preview.md: -------------------------------------------------------------------------------- 1 | * Fix: [read more](snippets/external-code-snippets#read-more) option change during preview now properly updates the snippet -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-11-json-params-and-auto-title.md: -------------------------------------------------------------------------------- 1 | * Add [JSON](snippets/json) parameters formalization 2 | * Add [JSON Auto Title](snippets/json#title) feature -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/add-2022-08-22-attention-sign-tip.md: -------------------------------------------------------------------------------- 1 | * Add [Tip](visuals/attention-signs#tip) and [Recommendation](visuals/attention-signs#recommendation) attention signs -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/add-2022-08-22-sql-cypher-graphql-syntax.md: -------------------------------------------------------------------------------- 1 | * Add syntax highlight for `SQL`, `GraphQL`, `Cypher` [code snippets](snippets/code-snippets#specifying-language) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-08-03-api-params-collapse.md: -------------------------------------------------------------------------------- 1 | * Add [collapsible](snippets/api-parameters#collapsing-parameters) option to [API Parameters](snippets/api-parameters) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59/add-2022-08-10-snippet-collapse.md: -------------------------------------------------------------------------------- 1 | * Add [collapsible](snippets/external-code-snippets#collapse) option to [Code Snippets](snippets/external-code-snippets) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.61/fix-2022-09-25-index-local-ref.md: -------------------------------------------------------------------------------- 1 | * Fix: [local ref](flow/page-references#links-links-to-subsection) in index page link doesn't add `/index` to url on ref click -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/add-2023-12-31-snippet-no-gap-separator.md: -------------------------------------------------------------------------------- 1 | * Add: [noGapSeparator](snippets/external-code-snippets#no-gap) to add a separator between code snippets with `noGap` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.67/add-2024-01-11-tabs-snippets-no-margin.md: -------------------------------------------------------------------------------- 1 | * Add: [Tabs](layout/tabs) remove vertical margin when the only content inside is a code snippet or api parameters -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.67/add-2024-01-27-ssl-jks-option.md: -------------------------------------------------------------------------------- 1 | * Add: `--jks-path` and `--jks-password` to enable SSL during preview that you run inside orgs that prefer to host SSL content -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.67/fix-2024-01-06-code-snippet-anchor.md: -------------------------------------------------------------------------------- 1 | * Fix: auto generated anchor from [title](snippets/external-code-snippets#title) can now be referenced from other pages -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-02-12-keep-start-end-single-lines.md: -------------------------------------------------------------------------------- 1 | * Add: [Keep Last/First Line](snippets/snippets-manipulation#start-end-multiple-lines) for multi start/end lines -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/add-2025-04-27-include-markdown-preprocessor.md: -------------------------------------------------------------------------------- 1 | * Add: `include-markdown` now supports `preprocessorPath` to change the content based on regexp from CSV file -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/add-2025-10-07-command-line-args-revamp.md: -------------------------------------------------------------------------------- 1 | * Add: Deprecate `znai --new`, `znai --preview`, `znai --serve` in favor of `znai new`, `znai preview`, `znai serve` -------------------------------------------------------------------------------- /znai-sphinx/sphinx-sample-doc/chapter-one/index.rst: -------------------------------------------------------------------------------- 1 | Chapter one 2 | =========== 3 | 4 | .. toctree:: 5 | :maxdepth: 2 6 | :caption: Contents: 7 | 8 | page-three 9 | 10 | -------------------------------------------------------------------------------- /znai-cli/src/main/resources/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Your Product", 3 | "type": "Guide", 4 | "viewOn": { 5 | "link": "your-custom-base-url", 6 | "title": "View On Label" 7 | } 8 | } -------------------------------------------------------------------------------- /znai-core/src/test/resources/sample-with-multi-marker.py: -------------------------------------------------------------------------------- 1 | # example: how to print 2 | print("hello") 3 | # example-end 4 | 5 | # procedure: how to print 6 | print("hello world") 7 | # procedure-end -------------------------------------------------------------------------------- /znai-docs/znai/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "cssResources": ["custom.css"], 3 | "jsResources": ["custom.js"], 4 | "htmlResources": ["custom.html"], 5 | "htmlHeadResources": ["tracking.html"] 6 | } -------------------------------------------------------------------------------- /znai-docs/znai/plugins/development.md: -------------------------------------------------------------------------------- 1 | # PlaceHolder 2 | 3 | Please create [GitHub Issue](https://github.com/testingisdocumenting/znai/issues) if you are interested in plugins creation documentation. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.53/add-2021-09-13-pydoc-params-dash-name.md: -------------------------------------------------------------------------------- 1 | * Add support for parameter names with dashes (`-`) to [python doc params](python/description-extraction#doc-parameters) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-23-zip-jar-lookup-path.md: -------------------------------------------------------------------------------- 1 | * Add [Zip and Jar](flow/lookup-paths#zip-and-jar-lookup) lookup path support to access content from within archives 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-24-image-annotation-bullet-list.md: -------------------------------------------------------------------------------- 1 | * Add automatic [Image Annotations](visuals/image-annotations) badges textual description tooltips via ordered list -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-05-remove-global-ref-js.md: -------------------------------------------------------------------------------- 1 | * Removed `global-references.js` for handling cross-references in favor of lazy url evaluation at page generation time -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-12-python-class-properties.md: -------------------------------------------------------------------------------- 1 | * Render [Python Properties](python/auto-reference#finmoneymoney-properties) as [API Parameters](snippets/api-parameters) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/fix-2022-08-22-api-params-fence-inside-tabs.md: -------------------------------------------------------------------------------- 1 | * Fix: [Tabs](layout/tabs) don't confuse Fence block of [API Parameters](snippets/api-parameters) with tab name -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2022-12-23-exclude-start-end-separately.md: -------------------------------------------------------------------------------- 1 | * Add: `excludeStart` and `excludeEnd` as separate options to [snippets manipulation](snippets/snippets-manipulation) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-01-exclude-include-contains.md: -------------------------------------------------------------------------------- 1 | * Add: `include` and `exclude` to [include/exclude](snippets/snippets-manipulation#include-contains) lines using contains -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-10-cli-output-highlight-remove-ansi.md: -------------------------------------------------------------------------------- 1 | * Add: [CLI Output Highlight](snippets/CLI#output-highlight) now matches sub-lines ignoring colors ANSI sequence -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-20-surrounded-by-validation.md: -------------------------------------------------------------------------------- 1 | * Add: [surroundedBy](snippets/snippets-manipulation#surrounded-by) validates that content is not empty after extraction -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-22-code-reference-fix.md: -------------------------------------------------------------------------------- 1 | * Fix: [code reference](snippets/code-references) now turns into links parts of code that is not fully recognized by highlighter -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/fix-2022-12-26-image-pusling-badge.md: -------------------------------------------------------------------------------- 1 | * Fix: stop badge [image annotation](visuals/image-annotations#badge-textual-description) from pulsing when mouse moved out -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.66/fix-2023-11-21-include-plugin-parser.md: -------------------------------------------------------------------------------- 1 | * Fix: Text right after [Include Plugin](introduction/what-is-this#extensive-plugins-system-include) is no longer ignored -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.67/add-2024-01-28-ssl-pem-option.md: -------------------------------------------------------------------------------- 1 | * Add: `--pem-cert-path` and `--pem-key-path` to enable SSL during preview that you run inside orgs that prefer to host SSL content -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.79/fix-2025-08-31-jupyter-include-section-fix.md: -------------------------------------------------------------------------------- 1 | * Fix: [Jupyter](snippets/jupyter-notebook) `includeSection` to handle section delimiter that has other text below it -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.80/fix-2025-09-08-ask-in-slack-trailing-slash.md: -------------------------------------------------------------------------------- 1 | * Fix: [Jupyter](snippets/jupyter-notebook) `includeSection` to handle section delimiter that has other text below it -------------------------------------------------------------------------------- /znai-maven-plugin-test/znai/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Your Product", 3 | "type": "Guide", 4 | "viewOn": { 5 | "link": "your-custom-base-url", 6 | "title": "View On Label" 7 | } 8 | } -------------------------------------------------------------------------------- /znai-typescript/vite.config.ts: -------------------------------------------------------------------------------- 1 | import { defineConfig } from "vite"; 2 | 3 | export default defineConfig({ 4 | test: { 5 | globals: true, 6 | environment: "jsdom", 7 | }, 8 | }); 9 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-03-include-python-doc.md: -------------------------------------------------------------------------------- 1 | * Added [include-python-doc](python/description-extraction#doc-string) to extract python docs as markdown text and add it to a page -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-09-17-pydoc-assignment-parse-fix.md: -------------------------------------------------------------------------------- 1 | * Enhance [python variable extraction](python/content-extraction) to include all assignments, not just global variables 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.54/add-2021-11-08-doxygen-func-params.md: -------------------------------------------------------------------------------- 1 | * Add [doxygen docs params](CPP/description-extraction#extract-parameters) to embed as [API parameters](snippets/api-parameters) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-08-wrap-code.md: -------------------------------------------------------------------------------- 1 | * Wrap code option for [Fence Block](snippets/code-snippets#wrap-code) and [External Code](snippets/external-code-snippets#wrap-code) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/add-2022-11-29-cli-output-and-anchor.md: -------------------------------------------------------------------------------- 1 | * Add: CLI Output [anchor support](snippets/CLI#anchor) 2 | * Add: [CLI Output](snippets/CLI) plugin formal parameters validation -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.62/doc-2022-11-26-code-reference-clarify.md: -------------------------------------------------------------------------------- 1 | * Doc: add clarification to dummy code reference page for [java](example-references/domain) and [generic](example-references/api) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.65/add-2023-09-27-iframe-properties-override.md: -------------------------------------------------------------------------------- 1 | * Add: [Properties override](visuals/iframe#properties-override) for iframe content based on active dark/light mode selection -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-02-12-highlight-region-by-scope-multistart.md: -------------------------------------------------------------------------------- 1 | * Add: multiple `start` lines to [Highlight Region With Scope](snippets/snippets-highlighting#region-using-scope) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/add-2024-11-10-footnote-normalize-labels.md: -------------------------------------------------------------------------------- 1 | * Add: [Footnote](flow/footnotes) references uses normalized labels like `1`, `2`, `3` instead of a user specified custom ids -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test-template.md: -------------------------------------------------------------------------------- 1 | text before section 2 | 3 | # Template Header One 4 | 5 | template body one 6 | 7 | # Template Header Two 8 | 9 | template body two 10 | -------------------------------------------------------------------------------- /znai-docs/znai/layout/instructions/java-install.md: -------------------------------------------------------------------------------- 1 | First you need to download Intellij IDEA and then run the following using your terminal 2 | 3 | $ mvn install 4 | $ mvn exec:exec 5 | 6 | -------------------------------------------------------------------------------- /znai-docs/znai/layout/instructions/javascript-install.md: -------------------------------------------------------------------------------- 1 | First you need to download WebStorm and then run the following using your terminal 2 | 3 | $ yarn install 4 | $ yarn start 5 | 6 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-06-05-plugins-params-formalization.md: -------------------------------------------------------------------------------- 1 | * Add initial plugin parameters formalization. Enforce parameters validation for [File Plugin](snippets/snippets-manipulation) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.65/add-2023-10-07-surrounded-by-multichars-scope.md: -------------------------------------------------------------------------------- 1 | * Add: [Surrounded By Multi-chars Scope](snippets/snippets-manipulation#surrounded-by-multi-chars-scope) text manipulation -------------------------------------------------------------------------------- /znai-docs/znai/snippets/callouts/file-name-with-comments.js: -------------------------------------------------------------------------------- 1 | class JsClass { 2 | constructor() { // new syntax for constructor 3 | } 4 | } 5 | 6 | export default JsClass // new syntax for ES6 modules -------------------------------------------------------------------------------- /znai-docs/znai/snippets/references/references-demo.csv: -------------------------------------------------------------------------------- 1 | constructor, https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/constructor 2 | usefulAction, example-references/api#useful-action -------------------------------------------------------------------------------- /znai-sphinx/sphinx-sample-doc/chapter-two/index.rst: -------------------------------------------------------------------------------- 1 | Chapter two 2 | =========== 3 | 4 | .. toctree:: 5 | :maxdepth: 2 6 | :caption: Contents: 7 | 8 | page-four 9 | page-five 10 | 11 | -------------------------------------------------------------------------------- /znai-tests/src/test/groovy/sampledoc/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Your Product", 3 | "type": "Guide", 4 | "viewOn": { 5 | "link": "your-custom-base-url", 6 | "title": "View On Label" 7 | } 8 | } -------------------------------------------------------------------------------- /znai-docs/pre-filter/maven-plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | org.testingisdocumenting.znai 3 | znai-maven-plugin 4 | ${project.version} 5 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.51/add-2021-06-21-img-anntations-explicit-autopath.md: -------------------------------------------------------------------------------- 1 | * Explicit use of `annotate:true` to use matching [image annotations file](visuals/image-annotations#annotations-path-shortcut) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/add-2025-03-15-preview-reuse-server.md: -------------------------------------------------------------------------------- 1 | * Add: preview server path to change preview server `srcRoot`: `/change-preview-path?srcRoot=&previewPageLink=` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.74/fix-2025-04-23-doc-id-multiple-parts-click-root.md: -------------------------------------------------------------------------------- 1 | * Fix: Clicking doc title when `docId` is a multipart (e.g. `part-one/part-two`) is now properly navigates to the landing page. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81/add-2025-10-19-jupyter-improved-render.md: -------------------------------------------------------------------------------- 1 | * Add: Jupyter notebooks improved search and llm.txt support 2 | * Add: Jupyter notebooks improved std output and tables cell rendering -------------------------------------------------------------------------------- /znai-docs/znai/snippets/callouts/file-name-with-multiline-comments.py: -------------------------------------------------------------------------------- 1 | order = fetch_order() 2 | # explanation of why 3 | # strategic price calculation 4 | # is important here 5 | price = strategic_price_calc(order) -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test-table.json: -------------------------------------------------------------------------------- 1 | [{"Account": "#12BGD3", "Price": 100, "Description": "custom table with a long attachment"}, 2 | {"Account": "#12BGD3", "Price": 150, "Description": "chair"}] -------------------------------------------------------------------------------- /znai-docs/znai/introduction/getting-started-installation.md: -------------------------------------------------------------------------------- 1 | ## CLI download 2 | 3 | :include-markdown: download-and-unzip.md 4 | 5 | ## Brew 6 | 7 | ```cli 8 | brew install testingisdocumenting/brew/znai 9 | ``` -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.55/add-2021-12-31-badge-colors.md: -------------------------------------------------------------------------------- 1 | * Color tweaks for [code snippet bullet points](snippets/code-comments#callout-comments) and [text badge](visuals/text-badge) for light and dark theme -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-22-plugin-params-validation-tweaks.md: -------------------------------------------------------------------------------- 1 | * Add: [Plugins](plugins/plugin-types) parameters validation error message now prints in the context of plugin name and passed params -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.76/add-2025-05-19-new-local-search-engine.md: -------------------------------------------------------------------------------- 1 | * Add: Migrate from [lunrjs](https://github.com/olivernn/lunr.js) to [flexsearchjs](https://github.com/nextapps-de/flexsearch) for local search -------------------------------------------------------------------------------- /znai-ddjt-docs/ddjt/toc: -------------------------------------------------------------------------------- 1 | introduction 2 | example 3 | getting-started 4 | data 5 | input-preparation 6 | matchers 7 | code 8 | components-testing 9 | dangerous-mocks 10 | building-fakes 11 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-04-20-java-groovy-entry-separator.md: -------------------------------------------------------------------------------- 1 | * No extra separator for [java](java/content-extraction#multiple-entries) and [groovy](snippets/groovy#multiple-bodies) entries separator 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.69/fix-2024-04-17-normalize-path-for-watch.md: -------------------------------------------------------------------------------- 1 | * Fix: normalize file watching path during preview mode to correctly detect documentation page change when file path contains extra "/./" in it -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/add-2025-05-04-markdown-toc-custom-path.md: -------------------------------------------------------------------------------- 1 | * Add: TOC now supports `{path: "neste/file.md"}` to select a markdown file in a custom location to make it easier to move existing content to Znai -------------------------------------------------------------------------------- /znai-java/src/test/resources/WithExtraLines.java: -------------------------------------------------------------------------------- 1 | class WithExtraLines { 2 | void method() { 3 | // some text here 4 | methodA(); 5 | doc.capture(); 6 | // another text here 7 | } 8 | } -------------------------------------------------------------------------------- /znai-reactjs/src/doc-elements/page/Page.css: -------------------------------------------------------------------------------- 1 | .page-content mark { 2 | background-color: var(--znai-search-preview-result-highlight-background-color); 3 | color: var(--znai-search-preview-result-highlight-color); 4 | } -------------------------------------------------------------------------------- /znai-docs/znai/layout/table/table.csv: -------------------------------------------------------------------------------- 1 | Account, Price, Description 2 | #12BGD3, 100, custom table with a long attachment 3 | #12BGD4, 90, custom table with a short attachment 4 | #12BGD5, 150, chair 5 | #91AGB1, 10, lunch 6 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.56/add-2022-03-23-java-groovy-multiple-body-separator.md: -------------------------------------------------------------------------------- 1 | * Added multiple entries separator for [Java](java/content-extraction#multiple-bodies) and [Groovy](snippets/groovy#multiple-bodies) 2 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.59.1/fix-2022-08-22-java-body-only-single-overload.md: -------------------------------------------------------------------------------- 1 | * Fix: [include-java](java/content-extraction#method-body) body only takes first method when overloads are present but no types are specified -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.68/add-2024-02-14-start-end-line-empty-validation.md: -------------------------------------------------------------------------------- 1 | * Add: validate non-empty [startLine](snippets/snippets-manipulation#start-end-line) and [endLine](snippets/snippets-manipulation#start-end-line) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.71/add-2024-09-24-additional-anchor-ids.md: -------------------------------------------------------------------------------- 1 | * Add: support for additional "hidden" anchor ids when referencing [Other Pages](flow/page-references) to be backward compatible with existing markdowns. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.76/add-2025-05-19-style-tweaks.md: -------------------------------------------------------------------------------- 1 | * Add: [Mermaid](visuals/mermaid-diagrams) css for message text - remove bold font 2 | * Add: [Read more](visuals/read-more) content extra spacing and bolder title -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.83/add-2025-11-12-search-highlight.md: -------------------------------------------------------------------------------- 1 | * Add: Local Search now highlights the section selected and highlights the matching terms. 2 | * Add: Local Search automatically expands `read-more` sections -------------------------------------------------------------------------------- /znai-docs/pre-filter/download-and-unzip.md: -------------------------------------------------------------------------------- 1 | Download and unzip [znai](https://repo.maven.apache.org/maven2/org/testingisdocumenting/znai/znai-dist/${project.version}/znai-dist-${project.version}-znai.zip). 2 | Add it to your `PATH`. -------------------------------------------------------------------------------- /znai-docs/znai/layout/table/table-many-columns.csv: -------------------------------------------------------------------------------- 1 | Account, Price, Zip Code, Rating, Description 2 | #12BGD3, 100, 11111, 4, custom table with a long attachment 3 | #12BGD3, 150, 22222, 5, chair 4 | #91AGB1, 10, 33333, 4.5, lunch 5 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.58/add-2022-07-08-python-method-def.md: -------------------------------------------------------------------------------- 1 | * Add [include-python-method: package.method_name](python/auto-reference#method-function-definition) to display a function signature, documentation and parameters -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/add-2023-03-10-json-paths-param-rename.md: -------------------------------------------------------------------------------- 1 | * Add: [JSON](snippets/json) rename `paths` to `highlightValue` and `pathsFile` to `highlightValueFile` to match `highlightKey` and `highlightKeyFile` pair -------------------------------------------------------------------------------- /znai-cli/src/main/resources/page-two.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | plugin-params.json will add implicit title to api-params plugin) 4 | 5 | ```api-parameters 6 | p1, int, parameter one 7 | p2, int, parameter two 8 | ``` 9 | 10 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.64/fix-2023-08-30-preview-sub-sections.md: -------------------------------------------------------------------------------- 1 | * Fix: During preview mode, [subsections](flow/page-references#links-links-to-subsection) anchor ids are no longer increasing the counter when editing the same file. -------------------------------------------------------------------------------- /znai-docs/znai/snippets/references/references-demo.json: -------------------------------------------------------------------------------- 1 | { 2 | "constructor": "https: //developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/constructor", 3 | "usefulAction": "example-references/api#useful-action" 4 | } -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test-with-marker.md: -------------------------------------------------------------------------------- 1 | # sample 2 | 3 | markdown is *simple* 4 | 5 | [comment]: <> (marker-to-surround) 6 | ``` 7 | code snippet 8 | multi line 9 | ``` 10 | [comment]: <> (marker-to-surround) -------------------------------------------------------------------------------- /znai-docs/znai/java/TransactionTypes.java: -------------------------------------------------------------------------------- 1 | package my.company; 2 | 3 | enum TransactionTypes { 4 | /** 5 | * buy intrument 6 | */ 7 | BUY, 8 | 9 | /** 10 | * sell instrument 11 | */ 12 | SELL 13 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/add-2021-05-16-inlined-snippet-validation.md: -------------------------------------------------------------------------------- 1 | * Add inlined code snippet with automatic identifier validation by looking into a provided file: [documentaiton](snippets/inlined-code-snippets#validated-identifier) -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2022-12-22-identifier-multiple-paths.md: -------------------------------------------------------------------------------- 1 | * Add: [identifier](snippets/inlined-code-snippets#validated-identifier) support for multiple validation paths. Example of using default parameters to simplify flow. -------------------------------------------------------------------------------- /znai-custom-components/.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | "stage-1", 4 | "react", 5 | [ 6 | "latest", 7 | { 8 | "es2015": { 9 | "modules": false 10 | } 11 | } 12 | ] 13 | ] 14 | } -------------------------------------------------------------------------------- /znai-docs/znai/layout/artifacts/names.json: -------------------------------------------------------------------------------- 1 | {"names": [ 2 | {"name": "Name 1", "description": "Description 1"}, 3 | {"name": "Name 2", "description": "Description 2", "optional": "true"}, 4 | {"name": "Name 3", "description": "Description 3"} 5 | ]} -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/2023.md: -------------------------------------------------------------------------------- 1 | # 1.66 2 | 3 | :include-markdowns: 1.66 4 | 5 | # 1.65 6 | 7 | :include-markdowns: 1.65 8 | 9 | # 1.64 10 | 11 | :include-markdowns: 1.64 12 | 13 | # 1.63 14 | 15 | :include-markdowns: 1.63 16 | 17 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/with-nested-if.js: -------------------------------------------------------------------------------- 1 | class JsClass { 2 | usefulAction() { 3 | if (userId === "user-a") { 4 | if (canRead(userId)) { 5 | // ... 6 | } 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /znai-docs/znai/java/HelloWorldTest.java: -------------------------------------------------------------------------------- 1 | public class HelloWorldTest { 2 | @Test 3 | public void exampleOfA() { 4 | a.action(); 5 | } 6 | 7 | @Test 8 | public void exampleOfB() { 9 | b.action(); 10 | } 11 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.80/add-2025-09-09-highlight-inside-codesnippet-readmore.md: -------------------------------------------------------------------------------- 1 | * Add: Initial attempt to highlight Slack questions inside code snippets "read more" part 2 | * Add: Initial attempt to highlight Slack questions inside read more blocks -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.81.1/add-2025-10-22-move-ssl-configs-to-env-var.md: -------------------------------------------------------------------------------- 1 | * Add: Move ssl related configs from command parameters to environment variables: `ZNAI_SSL_JKS_PATH`, `ZNAI_SSL_JKS_PASSWORD`, `ZNAI_SSL_PEM_CERT_PATH`, `ZNAI_SSL_PEM_KEY_PATH` -------------------------------------------------------------------------------- /znai-docs/znai/layout/table-multiline.csv: -------------------------------------------------------------------------------- 1 | Account, Price, Description 2 | #12BGD3, 100, "multi line markdown with 3 | * bullet point 4 | * list 5 | " 6 | #12BGD3, 150, "and some code snippet 7 | ```java 8 | class HelloWorld { 9 | } 10 | ``` 11 | " 12 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2023-01-02-trim-empty-lines-no-params.md: -------------------------------------------------------------------------------- 1 | * Add: [console output](snippets/CLI#output-highlight) and [code snippets](snippets/external-code-snippets) trim empty lines from start/end when no extraction specific params is set -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.76/add-2025-05-10-reference-markdowns-without-path-format-restriction.md: -------------------------------------------------------------------------------- 1 | * Add: Referencing another markdown via link is no longer restricted by a single `..` level 2 | * Add: A better error message when referencing a non-existing anchor -------------------------------------------------------------------------------- /znai-testing-examples/examples/rest/restGet.groovy: -------------------------------------------------------------------------------- 1 | package rest 2 | 3 | import static org.testingisdocumenting.webtau.WebTauGroovyDsl.* 4 | 5 | scenario("simple get") { 6 | http.get("/weather") { 7 | temperature.should == 88 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /znai-cli/src/main/resources/scaffold-index.md: -------------------------------------------------------------------------------- 1 | # Your product 2 | 3 | quick summary 4 | 5 | Note: This is a summary page for your product. It is your landing page, but is not a part of your Table Of Contents. 6 | If you don't know what to put here, delete this file 7 | -------------------------------------------------------------------------------- /znai-docs/znai/doxygen/src/structs.h: -------------------------------------------------------------------------------- 1 | template 2 | /** 3 | * @brief 4 | * my brief description 5 | * 6 | * @details 7 | * my detailed description 8 | */ 9 | struct MyStruct { 10 | /// type explanation `code` 11 | typedef T::type type; 12 | } -------------------------------------------------------------------------------- /znai-docs/znai/java/HelloWorldMarkdown.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Top level **conceptual** description of a `CustomDomain` problem. 3 | * * markdown *list* 4 | * * item two 5 | * ``` 6 | * code snippet 7 | * goes here 8 | * ``` 9 | */ 10 | class HelloWorld { 11 | } -------------------------------------------------------------------------------- /znai-docs/znai/snippets/WideCode.java: -------------------------------------------------------------------------------- 1 | class InternationalPriceService implements PriceService { 2 | private static void LongJavaInterfaceNameWithSuperFactory createMegaAbstractFactory(final ExchangeCalendarLongerThanLife calendar) { 3 | ... 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/ocaml/model.mli: -------------------------------------------------------------------------------- 1 | module ModelZero : sig 2 | type t 3 | end 4 | 5 | module ModelA : sig 6 | type t 7 | val calc: t -> int 8 | module Nested : sig 9 | type t 10 | end 11 | end 12 | 13 | module ModelC : sig 14 | type t 15 | end -------------------------------------------------------------------------------- /znai-docs/znai/visuals/flow-diagrams/nodes-lib-a.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "id": "a1", 4 | "label": "Label A 1" 5 | }, 6 | { 7 | "id": "a2", 8 | "label": "Label A 2" 9 | }, 10 | { 11 | "id": "a3", 12 | "label": "Label A 3" 13 | } 14 | ] -------------------------------------------------------------------------------- /znai-docs/znai/visuals/flow-diagrams/nodes-lib-b.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "id": "b1", 4 | "label": "Label B 1" 5 | }, 6 | { 7 | "id": "b2", 8 | "label": "Label B 2" 9 | }, 10 | { 11 | "id": "b3", 12 | "label": "Label B 3" 13 | } 14 | ] -------------------------------------------------------------------------------- /znai-docs/znai/hub/build-artifacts-watch.md: -------------------------------------------------------------------------------- 1 | # Todo 2 | 3 | Please create [GitHub Issue](https://github.com/testingisdocumenting/znai/issues) if you are interested in automatically watching a set of directories for 4 | built documentations to automatically upload them to Hub. -------------------------------------------------------------------------------- /znai-docs/znai/snippets/MyClass.java: -------------------------------------------------------------------------------- 1 | class MyClass { 2 | void action() { 3 | if (condition) { 4 | importantExample(); 5 | } 6 | 7 | if (anotherCondition) { 8 | anotherImportantExample(); 9 | } 10 | } 11 | } -------------------------------------------------------------------------------- /znai-java/src/test/resources/Enum.java: -------------------------------------------------------------------------------- 1 | enum Enum { 2 | /** 3 | * description of entry one 4 | */ 5 | ENTRY_ONE_WITH_A_LONG_NAME, 6 | 7 | /** 8 | * description of **entry two** 9 | */ 10 | @Deprecated 11 | ENTRY_TWO 12 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.50/_fix-2021-05-31-page-change-jump.md: -------------------------------------------------------------------------------- 1 | * Fix: auto jump to a changed page and highlight the right place. It was jumping to the right place, 2 | but was highlighting date time as the first change for pages that were last modified not in the same day. -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-20-api-params-long-param-names-wrap.md: -------------------------------------------------------------------------------- 1 | * Add automatic hard wrap and [noWrap](snippets/api-parameters#long-parameter-names) option to [API Parameters](snippets/api-parameters) 2 | to handle long parameter names without spaces 3 | -------------------------------------------------------------------------------- /znai-enterprise/src/test/resources/monitor.config.json: -------------------------------------------------------------------------------- 1 | { 2 | "intervalMillis": 20000, 3 | "paths": [ 4 | { 5 | "rootDir": "/Users/mykolagolubyev/work/fake-build-dir", 6 | "wildCardPatterns": [ 7 | "*/*.zip" 8 | ] 9 | } 10 | ] 11 | } -------------------------------------------------------------------------------- /znai-python/src/test/resources/pydoc-pandas-like-example-no-params.txt: -------------------------------------------------------------------------------- 1 | My documentation text blah 2 | in multiple lines when we include any text as py doc 3 | we exclude all the future sections 4 | 5 | Examples 6 | -------------- 7 | 8 | some examples are here and should be ignored -------------------------------------------------------------------------------- /znai-website-gen/src/main/resources/template/initial-page-loading.html: -------------------------------------------------------------------------------- 1 |
2 |
3 |
-------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | cache: 3 | directories: 4 | - $HOME/.m2 5 | - $HOME/.npm 6 | - node_modules 7 | dist: xenial 8 | services: 9 | - xvfb 10 | addons: 11 | chrome: stable 12 | apt: 13 | packages: 14 | - graphviz 15 | script: mvn -B install 16 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/file-with-scopes.txt: -------------------------------------------------------------------------------- 1 | print "hello" 2 | // some comment 3 | if (condition) { 4 | print "inside" 5 | } 6 | print "outside" 7 | if (anotherCondition) 8 | print "another inside" 9 | } 10 | if (someCondition) { 11 | print "another } inside" 12 | -------------------------------------------------------------------------------- /znai-docs/znai/flow/page-toc.md: -------------------------------------------------------------------------------- 1 | Use `include-page-toc` to include page top level sections as links 2 | 3 | ```markdown 4 | :include-page-toc: 5 | ``` 6 | 7 | :include-page-toc: 8 | 9 | # Section One 10 | 11 | some text 12 | 13 | # Section Two 14 | 15 | some other text 16 | -------------------------------------------------------------------------------- /znai-diagrams/src/test/resources/diagram-with-urls.json: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": [ 3 | { 4 | "id": "n1", 5 | "url": "doc/page" 6 | }, 7 | { 8 | "id": "n2", 9 | "url": "ref/another" 10 | } 11 | ], 12 | "edges": [ 13 | ["n1", "n2"] 14 | ] 15 | } -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.63/add-2022-12-21-no-gap-tweaks.md: -------------------------------------------------------------------------------- 1 | * Add: noGap option for images, tables, snippets and API parameters is only required for the first entry, second can omit it. 2 | If it does, third entry will have a gap again above. This helps with groups of snippets/tables/etc. -------------------------------------------------------------------------------- /znai-website-gen/src/main/resources/template/redirect.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | redirecting... 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /znai-docs/znai/java/references/javadoc-references-demo.csv: -------------------------------------------------------------------------------- 1 | CustomDomain, example-references/domain 2 | Trader, example-references/domain#trader 3 | Transaction, example-references/domain#transaction 4 | BUY, example-references/domain#transaction-buy 5 | SELL, example-references/domain#transaction-sell -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.60/add-2022-09-09-auto-anchor-from-title.md: -------------------------------------------------------------------------------- 1 | * Add: Auto anchor id from title for [Tables](layout/tables#title) 2 | * Add: Auto anchor id from title for [Snippets](snippets/external-code-snippets#title) 3 | * Add: Auto anchor id from title for [Images](visuals/images#title) -------------------------------------------------------------------------------- /znai-docs/znai/visuals/flow-diagrams/multiline-dag.json: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": [ 3 | { 4 | "id": "n1", 5 | "label": "input\none" 6 | }, 7 | { 8 | "id": "n2", 9 | "label": "output\ntwo" 10 | } 11 | ], 12 | "edges": [ 13 | ["n1", "n2"] 14 | ] 15 | } -------------------------------------------------------------------------------- /znai-docs/znai/snippets/markdown-dir/markdown-with-markers.md: -------------------------------------------------------------------------------- 1 | # Section One 2 | 3 | Some text 4 | 5 | # Section Two 6 | 7 | [comment]: <> (marker-one) 8 | 9 | Use these parameters to setup your work environment: 10 | ``` 11 | parameter=value 12 | ``` 13 | 14 | [comment]: <> (marker-one) 15 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/references/javadoc-references-demo.csv: -------------------------------------------------------------------------------- 1 | CustomDomain, example-references/domain 2 | Trader, example-references/domain#trader 3 | Transaction, example-references/domain#transaction 4 | BUY, example-references/domain#transaction-buy 5 | SELL, example-references/domain#transaction-sell -------------------------------------------------------------------------------- /znai-docs/znai/snippets/simple.cpp: -------------------------------------------------------------------------------- 1 | int main() { 2 | int test = 2; 3 | 4 | // comment with **important** 5 | // information 6 | int b = 3; 7 | int d = 3; 8 | 9 | /* 10 | * multi line comment 11 | * of multi *lines* text 12 | */ 13 | int e = 5; 14 | } 15 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/typescript/demo.tsx: -------------------------------------------------------------------------------- 1 | import { PrimaryButton } from 'my-lib'; 2 | 3 | function buttonsDemo(registry) { 4 | registry 5 | .add('primary', ) 6 | .add('primary disabled', ); 7 | } 8 | -------------------------------------------------------------------------------- /znai-docs/znai/flow/support.md: -------------------------------------------------------------------------------- 1 | # Linking To Support Site 2 | 3 | To provide a support link to your users add link and title to the `meta.json` file. 4 | 5 | :include-json: ../meta.json { 6 | highlightValue: "root.support.link" 7 | } 8 | 9 | Take a look at the example at the top of this page. 10 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.73/add-2024-11-09-header-tweaks.md: -------------------------------------------------------------------------------- 1 | * Add: Page sections allow **bold** and *italic* 2 | * Add: Better error message when unsupported styling is used in page sections 3 | * Add: Better handling of longer page sections 4 | * Add: Inlined code font size match when used inside page sections -------------------------------------------------------------------------------- /znai-docs/znai/visuals/editor-overview.json: -------------------------------------------------------------------------------- 1 | {"shapes": [ 2 | {"type": "rectangle", "id": "r2", 3 | "x": 140, "y": 135, "width": 220, "height": 240, "text": "", "color": "red"}, 4 | 5 | {"type": "rectangle", "id": "r1", 6 | "x": 593, "y": 5, "width": 255, "height": 180, "text": "", "color": "red"} 7 | ]} -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.57/add-2022-05-24-charts-breakpoint-conversion-validation.md: -------------------------------------------------------------------------------- 1 | * Add [Charts Presentation](visuals/charts#presentation) support for `all` breakpoint support that creates a slide for every textual value 2 | * Add [Charts Presentation](visuals/charts#presentation) breakpoint validation 3 | -------------------------------------------------------------------------------- /znai-docs/znai/synergy-with-testing/rest-test.json: -------------------------------------------------------------------------------- 1 | {"scenario":" # Department users list\n\nTo get access to current list of active users\npass department name as the last parameter\n","results":[{"id":"POST:/echo","method": "POST", "url":"/echo","body":{"id":2.0,"numberOfUsers":234.0},"paths":["body.numberOfUsers"]}]} -------------------------------------------------------------------------------- /znai-docs/znai/java/HelloWorldWithInner.java: -------------------------------------------------------------------------------- 1 | class HelloWorld { 2 | private int importantScore; 3 | 4 | public static class Nested { 5 | /** 6 | * system caclulates importance score based on following factors... 7 | */ 8 | private int importantScore; 9 | } 10 | } -------------------------------------------------------------------------------- /znai-docs/znai/snippets/global-references.js: -------------------------------------------------------------------------------- 1 | import * as fapi from 'flight-api' 2 | 3 | function bookFlight(flightInfo) { 4 | const confirmation = fapi.book(flightInfo) 5 | //... 6 | } 7 | 8 | function flightStatus(id) { 9 | const fullStatus = fapi.query(id) 10 | return fullStatus.shortStatus 11 | } -------------------------------------------------------------------------------- /znai-docs/znai/flow/shortcuts.csv: -------------------------------------------------------------------------------- 1 | Action, Shortcut 2 | Change to presentation mode, `:kbd: Alt =` or `:kbd: Alt +` 3 | Change to print mode, `:kbd: Alt p` 4 | Change to default mode, `:kbd: ESC` 5 | Activate search, `:kbd: /` 6 | Navigate to a previous page, `:kbd: Ctrl LeftArrow` 7 | Navigate to a next page, `:kbd: Ctrl RightArrow` -------------------------------------------------------------------------------- /znai-docs/znai/hub/introduction.md: -------------------------------------------------------------------------------- 1 | Znai has a server mode that can act as a Hub for your company documentations. 2 | In addition to serving static content, Hub provides: 3 | * Landing page, with all the documentations separated by sections 4 | * On-demand upload via CLI 5 | * Automatic build artifacts watching to grab the latest docs -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/test-flow.md: -------------------------------------------------------------------------------- 1 | # nginx->access_log 2 | 3 | NGINX stores every access to access.log. It also kerberizes the request. 4 | 5 | # access_log->log_stash_log 6 | 7 | Log Stash runs on the same machine and consumes access.log lines. 8 | As long as lines contain required information it gets send to Kafka -------------------------------------------------------------------------------- /znai-docs/znai/java/auto-reference.md: -------------------------------------------------------------------------------- 1 | # Coming Soon 2 | 3 | Auto reference similar to [Python](python/content-extraction) is planned for the future releases. 4 | 5 | Create a [GitHub Issue](https://github.com/testingisdocumenting/znai/issues) or [Discussion](https://github.com/testingisdocumenting/znai/discussions) 6 | to help prioritize -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/1.75/add-2025-05-04-asciinema-improvements.md: -------------------------------------------------------------------------------- 1 | * Add: [Aciinema](visuals/asciinema) new parameters: `cols`, `rows`, `idleTimeLimit`, `speed` 2 | * Add: [Aciinema](visuals/asciinema) reacts to parameter changes during preview mode 3 | * Add: [Aciinema](visuals/asciinema) bottom/top margins to match code snippets 4 | -------------------------------------------------------------------------------- /znai-diagrams/src/test/resources/graphviz-meta-conf.json: -------------------------------------------------------------------------------- 1 | { 2 | "man": { 3 | "shape": "octagon", 4 | "width": 0.7, 5 | "height": 1.5, 6 | "svgPath": "person.svg" 7 | }, 8 | 9 | "world": { 10 | "shape": "square", 11 | "width": 0.8, 12 | "height": 0.8, 13 | "svgPath": "world.svg" 14 | } 15 | } 16 | 17 | -------------------------------------------------------------------------------- /znai-docs/pre-filter/maven-plugin-llm.xml: -------------------------------------------------------------------------------- 1 | 2 | org.testingisdocumenting.znai 3 | znai-maven-plugin 4 | ${project.version} 5 | 6 | \${project.basedir}/full-guide.md 7 | 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .vscode 3 | /**/.settings 4 | /**/.mvn 5 | .classpath 6 | .project 7 | target 8 | node_modules 9 | znai-reactjs/build 10 | *.iml 11 | .vertx 12 | docs-build 13 | *.DS_Store 14 | dependency-reduced-pom.xml 15 | npm-debug.log 16 | todo.md 17 | local-overrides 18 | webtau.report.html 19 | .webtau-cache 20 | venv 21 | doc-artifacts -------------------------------------------------------------------------------- /znai-docs/znai/doxygen/src/math.h: -------------------------------------------------------------------------------- 1 | /** 2 | * \file math.h 3 | * 4 | * math utilities func 5 | */ 6 | 7 | namespace math { 8 | // math-add 9 | /** 10 | * sums two numbers 11 | * @param a number to add to 12 | * @param b number that is added 13 | * @return *sum* of **two** numbers 14 | */ 15 | int add(int a, int b); 16 | // math-add 17 | } -------------------------------------------------------------------------------- /znai-docs/znai/flow/footer.md: -------------------------------------------------------------------------------- 1 | # Definition 2 | 3 | To define a footer, create a `footer.md` file in the root directory of your documentation files. 4 | Footer content will be treated as regular page content, i.e., you can use the standard Markdown and all the custom extensions. 5 | 6 | Content in `footer.md` will be displayed at the bottom of each page. -------------------------------------------------------------------------------- /znai-docs/znai/snippets/ocaml/domain.mli: -------------------------------------------------------------------------------- 1 | 2 | (** 3 | Domain knowledge of the most important thing in the library. 4 | High level description that contains [User] information and some examples like 5 | {[ 6 | module My_module : sig 7 | ... 8 | end 9 | ]} 10 | More text. 11 | *) 12 | type t 13 | 14 | val act_on_domain : t -> unit Deferred.t -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/graphviz-meta-conf.json: -------------------------------------------------------------------------------- 1 | { 2 | "man": { 3 | "shape": "octagon", 4 | "width": 0.7, 5 | "height": 1.5, 6 | "svgPath": "person.svg" 7 | }, 8 | 9 | "world": { 10 | "shape": "square", 11 | "width": 0.8, 12 | "height": 0.8, 13 | "svgPath": "world.svg" 14 | } 15 | } 16 | 17 | -------------------------------------------------------------------------------- /znai-docs/znai/visuals/asciinema.md: -------------------------------------------------------------------------------- 1 | # Asciinema Player 2 | 3 | To embedd [Acsiinema Player](https://docs.asciinema.org/manual/player/quick-start/) use: 4 | 5 | ```markdown 6 | :include-asciinema: asciinema/intro.cast {startAt: "0:5", poster:"npt:0:5"} 7 | ``` 8 | 9 | :include-asciinema: asciinema/intro.cast {startAt: "0:5", poster:"npt:0:5"} 10 | -------------------------------------------------------------------------------- /znai-docs/znai/deployment/additional-files.md: -------------------------------------------------------------------------------- 1 | Znai automatically copies files like images to deploy location when you use them. 2 | 3 | Create `upload.txt` next to `toc` file and list all the additional files/directories you want to be copied to the deployment location. 4 | 5 | ```txt {title: "upload.txt"} 6 | my-extra-files/fileone.xml 7 | my-extra-dir 8 | ``` -------------------------------------------------------------------------------- /znai-enterprise/src/main/java/org/testingisdocumenting/znai/enterprise/storage/DocumentationStorageFactory.java: -------------------------------------------------------------------------------- 1 | package org.testingisdocumenting.znai.enterprise.storage; 2 | 3 | import org.testingisdocumenting.znai.server.ZnaiServerConfig; 4 | 5 | public interface DocumentationStorageFactory { 6 | DocumentationStorage create(ZnaiServerConfig config); 7 | } 8 | -------------------------------------------------------------------------------- /znai-docs/pre-filter/maven-plugin-cfg.xml: -------------------------------------------------------------------------------- 1 | 2 | org.testingisdocumenting.znai 3 | znai-maven-plugin 4 | ${project.version} 5 | 6 | znai 7 | 3334 8 | 9 | -------------------------------------------------------------------------------- /znai-docs/znai/visuals/text-badge.md: -------------------------------------------------------------------------------- 1 | # Part Of Text 2 | 3 | Use `badge` inlined code plugin to render a badge like this `:badge: v3.12` 4 | 5 | ``` 6 | to render a badge like this `:badge: v3.12` 7 | ``` 8 | 9 | # Part Of Heading {badge: "v3.12"} 10 | 11 | To add a badge to a header use 12 | 13 | ``` 14 | # Part Of Heading {badge: "v3.12"} 15 | ``` 16 | 17 | -------------------------------------------------------------------------------- /znai-reactjs/public/diamond.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /znai-docs/znai/visuals/diamond.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /znai-docs/znai/layout/table/table.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "Account": "#12BGD3", 4 | "Price": 100, 5 | "Description": "custom table with a long attachment" 6 | }, 7 | { 8 | "Account": "#12BGD3", 9 | "Price": 150, 10 | "Description": "chair" 11 | }, 12 | { 13 | "Account": "#91AGB1", 14 | "Price": 10, 15 | "Description": "lunch" 16 | } 17 | ] -------------------------------------------------------------------------------- /znai-docs/znai/visuals/gantt.plantuml: -------------------------------------------------------------------------------- 1 | @startgantt 2 | [Task1] lasts 4 days 3 | then [Task1.1] lasts 4 days 4 | [Task1.2] starts at [Task1]'s end and lasts 7 days 5 | 6 | [Task2] lasts 5 days 7 | then [Task2.1] lasts 4 days 8 | 9 | [MaxTaskEnd] happens at [Task1.1]'s end 10 | [MaxTaskEnd] happens at [Task1.2]'s end 11 | [MaxTaskEnd] happens at [Task2.1]'s end 12 | @endgantt 13 | -------------------------------------------------------------------------------- /znai-sphinx/sphinx-sample-doc/chapter-one/page-three.rst: -------------------------------------------------------------------------------- 1 | Page Three Title 2 | ================ 3 | 4 | some text here 5 | 6 | .. code-block:: python 7 | :emphasize-lines: 3,5 8 | 9 | def some_function(): 10 | interesting = False 11 | print 'This line is 2 highlighted.' 12 | print 'This one is not...' 13 | print '...but this one is.' 14 | 15 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/images/test.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/with-multiple-if.js: -------------------------------------------------------------------------------- 1 | class JsClass { 2 | usefulAction() { 3 | if (userId === "user-a") { 4 | if (canRead(userId)) { 5 | // ... 6 | } 7 | } 8 | if (userId === "user-b") { 9 | if (canWrite(userId)) { 10 | // ... 11 | } 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /znai-diagrams/src/test/resources/person.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /znai-docs/pre-filter/maven-deploy.xml: -------------------------------------------------------------------------------- 1 | 2 | org.testingisdocumenting.znai 3 | znai-maven-plugin 4 | ${project.version} 5 | 6 | project-name 7 | /path/to/static-content 8 | 9 | -------------------------------------------------------------------------------- /znai-docs/znai/example-references/api.md: -------------------------------------------------------------------------------- 1 | This page is a dummy page to demo [code reference](snippets/code-references) capabilities 2 | 3 | # Flight API 4 | 5 | Flight API summary placeholder 6 | 7 | # Book 8 | 9 | Lower level explanation of `fapi.book` 10 | 11 | # Query 12 | 13 | Lower level explanation of `fapi.query` 14 | 15 | # Useful Action 16 | 17 | stub for useful action description -------------------------------------------------------------------------------- /znai-java/src/test/resources/Simple.java: -------------------------------------------------------------------------------- 1 | class Simple { 2 | void methodA() { 3 | // inside method a 4 | } 5 | 6 | void methodB(String p) { 7 | doB(); 8 | } 9 | 10 | void methodB(String p, Boolean b) { 11 | doBPlus(); 12 | } 13 | 14 | Data createData() { 15 | return construction(a, b, 16 | c, d); 17 | } 18 | } -------------------------------------------------------------------------------- /znai-website-gen/src/test/resources/person.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /znai-core/src/test/resources/multiple-lines-start-stop.txt: -------------------------------------------------------------------------------- 1 | if (conditionA) { 2 | // inside condition A 3 | } 4 | 5 | if (conditionB) { 6 | // inside condition B 7 | } 8 | 9 | if (conditionA) { 10 | // line between 11 | if (conditionB) { 12 | // inside condition A and condition B 13 | doAction() 14 | } 15 | } 16 | 17 | if (conditionC) { 18 | // inside condition C 19 | } 20 | -------------------------------------------------------------------------------- /znai-docs/znai/release-notes/2024.md: -------------------------------------------------------------------------------- 1 | # 1.73 2 | 3 | :include-markdowns: 1.73 4 | 5 | # 1.72 6 | 7 | :include-markdowns: 1.72 8 | 9 | # 1.71 10 | 11 | :include-markdowns: 1.71 12 | 13 | # 1.70 14 | 15 | :include-markdowns: 1.70 16 | 17 | # 1.69 18 | 19 | :include-markdowns: 1.69 20 | 21 | # 1.68 22 | 23 | :include-markdowns: 1.68 24 | 25 | # 1.67 26 | 27 | :include-markdowns: 1.67 28 | 29 | -------------------------------------------------------------------------------- /znai-docs/znai/snippets/python-examples.py: -------------------------------------------------------------------------------- 1 | # example-import-block 2 | import market 3 | # example-import-block 4 | 5 | def main(): 6 | # example: book trade 7 | id = market.book_trade('symbol', market.CURRENT_PRICE, 100) 8 | # example-end 9 | 10 | # example-cancel-trade 11 | market.cancel_trade(id) 12 | # example-cancel-trade 13 | 14 | if __name__ == "__main__": 15 | main() -------------------------------------------------------------------------------- /znai-python/src/test/resources/pydoc-params.py: -------------------------------------------------------------------------------- 1 | def my_func(label, price): 2 | """ 3 | text inside my *func* doc 4 | * list one 5 | * list two 6 | 7 | Parameters 8 | __________ 9 | label : String 10 | 11 | label to use to *render* item in the store 12 | 13 | price : Money 14 | 15 | price associated with the **item** 16 | """ 17 | 18 | print("hello") 19 | --------------------------------------------------------------------------------