# Custom Pages You can host your own custom documentation pages directly within your Onyxia instance.\ This is ideal if you want to provide onboarding instructions or write step-by-step tutorials specifically tailored to your users. {% embed url="" %} ## How It Works Your documentation must consist of Markdown files. These files will be rendered as HTML within the Onyxia UI.\ The documents must be hosted within your Onyxia instance; external links are not supported. You need to include them in the `custom-resources.zip` file, provided through the `CUSTOM_RESOURCES` configuration key.\ More details are available in the [theme and branding documentation](/admin-doc/theme.md). You can link to your Markdown files from any customizable section of the interface: header, sidebar, footer, and even from other Markdown files. ### Example Assume we include the following files in `custom-resources.zip`: ``` /onboarding_en.md /onboarding_fr.md ``` We can reference them in our configuration:

onyxia:
  web:
    env:
      CUSTOM_RESOURCES: "https://.../custom-resources.zip"
      HEADER_TEXT_BOLD: My Organization
      HEADER_TEXT_FOCUS: Datalab
      HEADER_LINKS: |
        [
          {
            label: {
              en: "Onboarding Guide",
              fr: "Guide d'intégration"
            },
            icon: "School",
            url: {
              en: "%PUBLIC_URL%/custom-resources/onboarding_en.md",
              fr: "%PUBLIC_URL%/custom-resources/onboarding_fr.md"
            }
          }
        ]
      FOOTER_LINKS: |
        [
          {
            label: {
              en: "Onboarding Guide",
              fr: "Guide d'intégration"
            },
            icon: "School",
            url: {
              en: "%PUBLIC_URL%/custom-resources/onboarding_en.md",
              fr: "%PUBLIC_URL%/custom-resources/onboarding_fr.md"
            }
          }
        ]
      HOMEPAGE_BELOW_HERO_TEXT: |
        {
          en: "See our [onboarding guide](%PUBLIC_URL%/custom-resources/onboarding_en.md)",
          fr: "Consultez notre [guide d'intégration](%PUBLIC_URL%/custom-resources/onboarding_fr.md)"
        }
      HOMEPAGE_CALL_TO_ACTION_BUTTON: |
        {
          label: {
            en: "Read our get started guide",
            fr: "Lire notre guide de démarrage"
          },
          startIcon: "School",
          url: {
            en: "%PUBLIC_URL%/custom-resources/onboarding_en.md",
            fr: "%PUBLIC_URL%/custom-resources/onboarding_fr.md"
          }
        }
      TERMS_OF_SERVICES: "%PUBLIC_URL%/custom-resources/tos_fr.md"

Example of Mardown document {% code title="onboarding\_en.md" %} ````markdown # This is a test document in english This could be for example a guide specific to your Onyxia instance. ## It's standard markdown You can embed images, including with HTML syntax:

You can render code snippets: ```bash echo "Hello world" ``` You can also link to pages of your instance: [Catalog](/catalog). You can link to [another document](%PUBLIC_URL%/custom-resources/onboarding_sub_en.md).

```` {% endcode %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.onyxia.sh/admin-doc/custom-pages.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.