diff --git a/docs/how-to-build.md b/docs/how-to-build.md index 0a8a76d..7639e48 100644 --- a/docs/how-to-build.md +++ b/docs/how-to-build.md @@ -19,7 +19,8 @@ pandoc docs/usage/create-project.md -o create3.pdf --pdf-engine=xelatex --extrac pandoc docs/usage/create-project.md -o create4.pdf --extract-media= -Plugins for PDF export: https://github.com/zhaoterryy/mkdocs-pdf-export-plugin. Installation: +Plugins for PDF export: https://github.com/zhaoterryy/mkdocs-pdf-export-plugin. Links in combined files are broken: https://github.com/zhaoterryy/mkdocs-pdf-export-plugin/issues/43 +Installation: - pdf-export: combined: true @@ -30,3 +31,9 @@ Plugins for PDF export: https://github.com/zhaoterryy/mkdocs-pdf-export-plugin. 2. After installation, in MSYS2’s shell, execute `pacman -S mingw-w64-x86_64-pango`. 3. Close MSYS2’s shell. 3. Follow the installation procedure described [here](https://github.com/zhaoterryy/mkdocs-pdf-export-plugin?tab=readme-ov-file#installation). + +Variables: consider using Mkdocs-macros plugin: https://mkdocs-macros-plugin.readthedocs.io/en/latest/#:~:text=Getting%20started-,Definition,md%20extension). + + - with-pdf plugin (code samples are not visisble): https://github.com/orzih/mkdocs-with-pdf + + - print-site plugin to create one web page and generate pdf from browser (pint - save as pdf) https://github.com/timvink/mkdocs-print-site-plugin \ No newline at end of file diff --git a/docs/usage/create-process.md b/docs/usage/create-process.md index ed8347c..2c76d23 100644 --- a/docs/usage/create-process.md +++ b/docs/usage/create-process.md @@ -14,7 +14,7 @@ Our platform supports various process types: 1. Open your [project](create-project.md) 2. Select "New Process" -3. Choose a process type +3. Choose a process dfdfd type 4. Configure steps !!! example "Example Process" diff --git a/docs/usage/create-project.md b/docs/usage/create-project.md index 1b268d2..0372749 100644 --- a/docs/usage/create-project.md +++ b/docs/usage/create-project.md @@ -11,7 +11,7 @@ Follow these steps to create your first project: - Description - Team members -!!! tip "Project Templates" +!!! tip "Project templates" Use our pre-built templates to get started quickly. Access them from the "Templates" dropdown. See [Create a Process](create-process.md) for next steps. diff --git a/docs/usage/test-project.md b/docs/usage/test-project.md index 0f424af..52c0994 100644 --- a/docs/usage/test-project.md +++ b/docs/usage/test-project.md @@ -31,4 +31,5 @@ pytest tests/unit/ assert project.status == "Active" ``` -See [Installation Guide](../installation.md) for setup requirements. \ No newline at end of file +See [Installation Guide](../installation.md) for setup requirements. +lsfödö \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 98633c4..e5206f1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,7 +35,8 @@ theme: note: >- Thanks for your feedback! Help us improve this page by using our feedback form. - +use_directory_urls: false + nav: - Home: index.md - Software Project Overview: overview.md @@ -46,8 +47,9 @@ nav: - Create a Process: usage/create-process.md - Test a Project: usage/test-project.md plugins: - - search + - search # To generate pdfs add pdf-export: plugin with combined: true option +# To create a combined web page of the whole website and generate a pdf from it from the browser (print - save as pdf), use the "print-site" plugin at the bottom of the plugin lists: https://github.com/timvink/mkdocs-print-site-plugin markdown_extensions: - tables @@ -63,4 +65,4 @@ markdown_extensions: - attr_list - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg \ No newline at end of file + emoji_generator: !!python/name:material.extensions.emoji.to_svg