diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml deleted file mode 100644 index 6eff2919e..000000000 --- a/.github/workflows/build-test.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Internal PR linkcheck -on: - pull_request: - branches: - - main -permissions: - contents: read - pull-requests: write -jobs: - link-check: - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - name: Setup Python - uses: actions/setup-python@v2 - with: - python-version: 3.12 - - name: Install dependencies - run: | - python3 -m venv venv - source venv/bin/activate - pip install -r requirements.txt - pip install mkdocs-material - - name: Run mkdocs in strict mode - id: mkdocs - run: | - source venv/bin/activate - mkdocs build --config-file mkdocs-test.yml --strict 2>&1 | tee mkdocs.out - [[ $(tail -n 1 mkdocs.out) =~ ^Aborted ]] && exit 1 || exit 0 - - - name: PR comment with file - if: failure() - uses: thollander/actions-comment-pull-request@e4a76dd2b0a3c2027c3fd84147a67c22ee4c90fa # v3.0.1 - with: - file-path: mkdocs.out - comment-tag: execution - mode: recreate diff --git a/README.md b/README.md index c76e5040a..47c474825 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ pip install mkdocs-material #### To serve a local preview: ``` -mkdocs serve +mkdocs serve --strict ``` ## Contributing diff --git a/_submodules/insiders b/_submodules/insiders index f2492fbd2..782d920de 160000 --- a/_submodules/insiders +++ b/_submodules/insiders @@ -1 +1 @@ -Subproject commit f2492fbd2d6d6aef6a8f066cce6d5ceef80a961e +Subproject commit 782d920de7fb2800277c42cf83d33483f9064a71 diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md index e06b7eb20..1f51fdcb0 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md @@ -166,6 +166,7 @@ Configure this operation with these parameters: * `connections` * `settings` + Refer to the [n8n API | Update a workflow documentation](https://docs.n8n.io/api/api-reference/#tag/Workflow/paths/~1workflows~1%7Bid%7D/put) for more information. ## Templates and examples diff --git a/mkdocs-test.yml b/mkdocs-test.yml deleted file mode 100644 index 645ba43cd..000000000 --- a/mkdocs-test.yml +++ /dev/null @@ -1,174 +0,0 @@ -site_name: n8n Docs -site_url: https://docs.n8n.io/ -site_description: Documentation for n8n, a workflow automation platform. -# Must be the docs repo for the edit page buttons to work -repo_url: https://github.com/n8n-io/n8n-docs -edit_uri: edit/main/docs/ -validation: - nav: - omitted_files: info - not_found: warn - absolute_links: ignore - links: - not_found: warn - absolute_links: relative_to_docs - unrecognized_links: info -theme: - name: material - custom_dir: _overrides - favicon: _images/favicon.ico - font: false - language: custom - logo: _images/n8n-docs-icon.svg - palette: - scheme: light - features: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#announcement-bar - - announce.dismiss - # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions - - content.action.edit - # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations - - content.code.annotate - # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs - - content.tabs.link - # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button - - content.code.copy - # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips - - content.tooltips - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/?h=footer#navigation - - navigation.footer - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages - - navigation.indexes - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path - - navigation.path - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections - - navigation.sections - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#navigation-tabs - - navigation.tabs - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button - - navigation.top - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#anchor-tracking - - navigation.tracking -copyright: > - Change cookie settings -extra: - analytics: - provider: google - property: G-0SC4FF2FH9 - consent: - title: Cookie consent - description: >- - We use cookies and other tracking technologies to improve your browsing experience, - to analyze our website traffic, assist our marketing efforts and to understand where - our visitors are coming from.
Privacy policy - # https://squidfunk.github.io/mkdocs-material/reference/#setting-the-page-status - status: - beta: This feature is in beta -# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-css -extra_css: - - _extra/css/extra.css - - _extra/css/macro-styles.css - - _extra/css/templates-widget.css - - _extra/css/workflow-demo.css - - _extra/css/feedback.css -# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-javascript -extra_javascript: - - _extra/javascript/extra.js -watch: - - _glossary - - _snippets -markdown_extensions: - # used for https://squidfunk.github.io/mkdocs-material/reference/tooltips/ - - abbr - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr#attribute-lists - # attr_list is required for several other features. Always enable. - - attr_list - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#automatic-previews - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html - - md_in_html - - meta - - pymdownx.blocks.admonition: - types: - - note - - info - - tip - - question - - warning - - danger - # custom types - - details - - pymdownx.details - # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/ - - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight - - pymdownx.highlight: - linenums: true - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite - - pymdownx.inlinehilite - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys - - pymdownx.keys - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets - - pymdownx.snippets: - auto_append: - - _glossary/main.md - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences Superfences is required for several other features. Always enable. - - pymdownx.superfences: - # https://squidfunk.github.io/mkdocs-material/reference/diagrams/ - custom_fences: - - name: mermaid - class: mermaid - format: - !!python/name:pymdownx.superfences.fence_code_format - # https://facelessuser.github.io/pymdown-extensions/extensions/superfences/#preserve-tabs - preserve_tabs: true - - pymdownx.tasklist: - custom_checkbox: true - # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed - - pymdownx.tabbed: - alternate_style: true - - sane_lists - - tables - # https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages - - toc: - permalink: "#" -plugins: - # You need the info plugin for bug reports to Material theme - # But DO NOT ENABLE IT NORMALLY - # It causes Netlify builds to fail - # - info - # Search is built in, but must be enabled when you add other plugins - - search - - exclude: - glob: - # - integrations/builtin/* - # https://squidfunk.github.io/mkdocs-material/reference/images/#lightbox - - glightbox: - touchNavigation: false - loop: false - effect: zoom - slide_effect: none - width: auto - height: auto - zoomable: false - draggable: false - auto_caption: false - caption_position: bottom - # https://mkdocs-macros-plugin.readthedocs.io/en/latest/ - - macros: - # https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#including-external-yaml-files - include_yaml: - - _yaml/data-functions.yml - j2_block_start_string: "[[%" - j2_block_end_string: "%]]" - j2_variable_start_string: "[[" - j2_variable_end_string: "]]" - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/ - - tags: - enabled: true - # https://squidfunk.github.io/mkdocs-material/plugins/privacy/ - # This is enabled to automatically add `target="_blank"` to external links. - # Specifically, we needed some way to open nav links to external locations - # (like the main site) in new tabs - - privacy: - assets: false -INHERIT: ./nav.yml \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index ba5b3ca61..73d47d471 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,13 +6,14 @@ repo_url: https://github.com/n8n-io/n8n-docs edit_uri: edit/main/docs/ validation: nav: - omitted_files: info + omitted_files: warn not_found: warn - absolute_links: ignore + absolute_links: warn links: not_found: warn + anchors: warn absolute_links: relative_to_docs - unrecognized_links: info + unrecognized_links: warn theme: name: material custom_dir: _overrides diff --git a/nav.yml b/nav.yml index d1245e9d5..90ff5613a 100644 --- a/nav.yml +++ b/nav.yml @@ -1332,8 +1332,8 @@ nav: - Workflow management: embed/managing-workflows.md - Workflows templates: embed/workflow-templates.md - White labelling: embed/white-labelling.md -# - Feature tests: -# - Main features: docs-site-feature-tests/index.md -# + # - Feature tests: + # - Main features: docs-site-feature-tests/index.md + not_in_nav: | /integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolhttprequest.md diff --git a/netlify.toml b/netlify.toml index a2bd8cac2..f3e1e0fb7 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,5 +1,5 @@ [build] - command = "pip install _submodules/insiders && mkdocs build" + command = "pip install _submodules/insiders && mkdocs build --strict" publish = "site" [[headers]] for = "/*" diff --git a/requirements.txt b/requirements.txt index ceb5bb7fa..381c52366 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ -mkdocs==1.6.1 mkdocs-exclude==1.0.2 mkdocs-glightbox -mkdocs-macros-plugin==1.0.4 +mkdocs-macros-plugin==1.3.7