diff --git a/.github/workflows/retype-action.yml b/.github/workflows/retype-action.yml index 407cdca..9452a3f 100644 --- a/.github/workflows/retype-action.yml +++ b/.github/workflows/retype-action.yml @@ -1,4 +1,4 @@ -name: Publish Retype powered website to GitHub Pages +name: Publish Retype powered website for the BonaRes standards report to GitHub Pages on: workflow_dispatch: push: @@ -11,15 +11,11 @@ jobs: runs-on: ubuntu-latest - permissions: - contents: write - steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v2 - uses: retypeapp/action-build@latest - uses: retypeapp/action-github-pages@latest with: - branch: main update-branch: true \ No newline at end of file diff --git a/retype.yml b/retype.yml index f8840a0..db70734 100644 --- a/retype.yml +++ b/retype.yml @@ -1,6 +1,16 @@ -input: . -output: .retype -url: bonares-handbook.github.io +input: src # The local path from this retype.yml file to your content files. + +# ----------------------------------------------------------------------------- + +output: docs # Custom path to the output directory. + +# ----------------------------------------------------------------------------- + +url: https://zalf-rdm.github.io/ # The base URL of your website. + +# + + favicon: static/img/zalf_logo.svg # ----------------------------------------------------------- branding: @@ -10,11 +20,63 @@ branding: label: # Label colors text: "#ff0000" # Custom color for the label text. background: "#ff0000" -# ----------------------------------------------------------- -links: -- text: Getting Started - link: https://retype.com/guides/getting-started/ +# ----------------------------------------------------------------------------- + +poweredByRetype: true # Set to false to remove the Powered by Retype branding. + # A Retype Pro license is required. + # See: https://retype.com/pro + +# ----------------------------------------------------------------------------- + +links: # A list of custom links to add to the top bar of the generated website. + # See also: footer.links + - text: Home of this report # The text to use for the link + link: index.md # start page of this report + icon: home # A custom icon name, :emoji:, , or path to a file. + conAlign: left # Icon alignment, to the left or right. Default is left. + - text: BonaRes Portal + link: https://www.bonares.de # Link to an internal file or external URL. + icon: globe + target: blank # Custom target. Use blank to open link in a new window. + +# ----------------------------------------------------------------------------- + footer: - copyright: "© Copyright {{ year }}. All rights reserved." -editor: - enabled: false + copyright: "© Copyright . All rights reserved." # A custom copyright statement + links: # A list of links to include in the footer. + # See also: links + - text: Imprint # The text to use for the link + link: https://www.bonares.de/imprint + - text: Privacy Policy + link: https://www.bonares.de/privacypolicy + - text: License + link: license.md + +# ----------------------------------------------------------------------------- + +generator: + recase: all # Set to `none` to not recase any file or folder names. + # By default, all generated file and folder names are + # generated in all lowercase. + +# ----------------------------------------------------------------------------- + + + +search: # Custom configuration of the website search component. + hotkeys: + - "/" # Keyboard key to set the cursor focus into the search field. + maxResults: 20 # Max number of search results to render. + minChars: 2 # Min number of characters required to trigger a sear.ch + mode: full # The search index creation mode. + # Options include: full | partial | basic + noResultsFoundMsg: "No results" # Message when no results are found. + placeholder: Search # Placeholder text used in the search input field. + +# ----------------------------------------------------------------------------- + +templating: + enabled: true # Enable or disable the Retype content templating engine. + liquid: false # Is Liquid syntax {% ... %} enabled? + # If true, Retype is incompatible with + # GitBook style of component configuration. diff --git a/01_submit_research_data/01data_preparation.md b/src/01_submit_research_data/01data_preparation.md similarity index 100% rename from 01_submit_research_data/01data_preparation.md rename to src/01_submit_research_data/01data_preparation.md diff --git a/01_submit_research_data/02registration_in_bonares.md b/src/01_submit_research_data/02registration_in_bonares.md similarity index 100% rename from 01_submit_research_data/02registration_in_bonares.md rename to src/01_submit_research_data/02registration_in_bonares.md diff --git a/01_submit_research_data/default.md b/src/01_submit_research_data/default.md similarity index 100% rename from 01_submit_research_data/default.md rename to src/01_submit_research_data/default.md diff --git a/02_metadata/01data.md b/src/02_metadata/01data.md similarity index 100% rename from 02_metadata/01data.md rename to src/02_metadata/01data.md diff --git a/02_metadata/default.md b/src/02_metadata/default.md similarity index 100% rename from 02_metadata/default.md rename to src/02_metadata/default.md diff --git a/03_creation_of_templates/default.md b/src/03_creation_of_templates/default.md similarity index 100% rename from 03_creation_of_templates/default.md rename to src/03_creation_of_templates/default.md diff --git a/04_help/default.md b/src/04_help/default.md similarity index 100% rename from 04_help/default.md rename to src/04_help/default.md diff --git a/05_glossary/default.md b/src/05_glossary/default.md similarity index 100% rename from 05_glossary/default.md rename to src/05_glossary/default.md diff --git a/06_german_translation/default.md b/src/06_german_translation/default.md similarity index 100% rename from 06_german_translation/default.md rename to src/06_german_translation/default.md