diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 650d91a..a9923f4 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -2,8 +2,8 @@ name: Deploy to S3 on: push: - pull_request: - types: [opened, synchronize, reopened, closed] +# pull_request: +# types: [opened, synchronize, reopened, closed] workflow_dispatch: workflow_run: workflows: ["Sync Submodules"] @@ -32,18 +32,18 @@ jobs: - name: Upload official docs if: ${{ github.event_name != 'pull_request' }} run: | - aws s3 cp --recursive public s3://br-www-docs/blueos/${{ github.ref_name }} - - - name: Upload proposal preview - if: ${{ github.event_name == 'pull_request' }} - run: | - aws s3 cp --recursive public s3://br-www-docs/preview/blueos/pull/${{ github.event.pull_request.number }} - - cleanup: - runs-on: ubuntu-latest - if: ${{ github.event.pull_request.action == 'closed' }} - steps: - - name: Remove proposal preview - run: | - aws s3 rm --recursive s3://br-www-docs/preview/blueos/pull/${{ github.event.pull_request.number }} + aws s3 cp --recursive public s3://br-www-docs/docs/${{ github.ref_name }} + +# - name: Upload proposal preview +# if: ${{ github.event_name == 'pull_request' }} +# run: | +# aws s3 cp --recursive public s3://br-www-docs/preview/blueos/pull/${{ github.event.pull_request.number }} +# +# cleanup: +# runs-on: ubuntu-latest +# if: ${{ github.event.pull_request.action == 'closed' }} +# steps: +# - name: Remove proposal preview +# run: | +# aws s3 rm --recursive s3://br-www-docs/preview/blueos/pull/${{ github.event.pull_request.number }} diff --git a/.gitmodules b/.gitmodules index 26d36e8..8f60eef 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,6 @@ [submodule "themes/adidoks"] path = themes/adidoks url = https://github.com/ES-Alexander/adidoks.git +[submodule "bluetheme"] + path = themes/bluetheme + url = https://github.com/BlueRobotics/bluetheme diff --git a/config.toml b/config.toml index 4634118..de0426f 100644 --- a/config.toml +++ b/config.toml @@ -3,7 +3,7 @@ base_url = "https://blueos.cloud/docs/latest" title = "BlueOS latest" # The site theme to use. -theme = "adidoks" +theme = "bluetheme" # The default language; used in feeds and search index default_language="en" @@ -29,45 +29,3 @@ include_content = true # Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola highlight_code = true -[extra] -ahrefs_verification_code = "68b21d8843bcc0ce30035c553ab9c2ac579c8ebfb8698573ea4f96f49ae00517" - -# Put all your custom variables here -github = "https://github.com/bluerobotics" - -# Set HTML file language -language_code = "en-US" - -# Set theme-color meta tag for Chrome browser -theme_color = "#fff" - -# Edit page on reposity or not -edit_page = true -docs_repo = "https://github.com/bluerobotics/ardusub-zola" -repo_branch = "main" - -## Math settings -# options: true, false. Enable math support globally, -# default: false. You can always enable math on a per page. -math = false -library = "katex" # options: "katex", "mathjax". default is "katex". - -[[extra.menu.social]] -name = "GitHub" -pre = '' -url = "https://github.com/bluerobotics/ardusub-zola" -# post = "v0.1.0" -weight = 20 - -# Avoid "Docs" and "Blog" links in header -[[extra.menu.main]] -name = "" -url = "" -section = "" - -# Footer contents -[extra.footer] -info = 'Powered by Zola and AdiDoks. Sponsored by Blue Robotics.' - -[extra.footer.nav] -info = 'Code under GPLv3 License. Documentation under CC-NC-SA 4.0.' diff --git a/content/_index.md b/content/_index.md index 47bd37f..5532204 100644 --- a/content/_index.md +++ b/content/_index.md @@ -6,6 +6,5 @@ sort_by = "weight" weight = 1 draft = false -[extra] -document_version = "1.0" +redirect_to = "usage/overview" +++ diff --git a/templates/docs/overview-section.html b/templates/docs/overview-section.html index 3832aa1..8538524 100644 --- a/templates/docs/overview-section.html +++ b/templates/docs/overview-section.html @@ -1,4 +1,4 @@ -{% extends "section.html" %} +{% extends "docs/section.html" %} {% block body %} {% set page_class = "docs list" %} diff --git a/templates/docs/page.html b/templates/docs/page.html deleted file mode 100644 index 9fed944..0000000 --- a/templates/docs/page.html +++ /dev/null @@ -1,31 +0,0 @@ -{% extends "page.html" %} - -{% block body %} - {% set page_class = "docs single" %} -{% endblock body %} - -{% block header %} - {# This value is matched by the config.extra.menu.main~url #} - {% set current_section = page.path | split(pat="/") | slice(end=-2) | join(sep="/") %} - {{ macros_header::header(current_section=current_section)}} -{% endblock header %} - -{% block content %} -
-
-
- {{ macros_sidebar::docs_sidebar(current_section=current_section) }} - {{ macros_toc::docs_toc(page=page) }} -
-

{{ page.title }}

- {% if page.extra.lead %}

{{ page.extra.lead | safe }}

{% endif %} - {{ page.content | safe }} - {% if config.extra.edit_page %} - {{ macros_edit_page::docs_edit_page(current_path=current_path) }} - {% endif %} - {{ macros_navigation::docs_navigation(page=page, current_section=current_section) }} -
-
-
-
-{% endblock content %} diff --git a/templates/docs/section.html b/templates/docs/section.html deleted file mode 100644 index 1113024..0000000 --- a/templates/docs/section.html +++ /dev/null @@ -1,52 +0,0 @@ -{% extends "section.html" %} - -{% block body %} - {% set page_class = "docs list" %} -{% endblock body %} - -{% block header %} - {# This value is matched by the config.extra.menu.main~section #} - {% set current_section = "" %} - {{ macros_header::header(current_section=current_section)}} -{% endblock header %} - -{% block content %} -
-
-
-
-
-

{{ section.title }}

-
{{ section.content | safe }}
-
- {% set index_path = current_path ~ "_index.md" | trim_start_matches(pat="/") %} - {% set index = get_section(path=index_path) %} - {% for page in index.pages %} -
-
- {{ page.title }} → -
-
- {% endfor %} - {# Sections sorted by weight #} - {% set subsections = index.subsections %} - {% for s in subsections %} - {% set subsection = get_section(path=s) %} - {% set_global subsection_title = subsection.title ~ ' →' %} - {# Check if section is versioned #} - {% if 'document_version' in subsection.extra %} - {% set_global subsection_title = subsection.title ~ ' - ' ~ subsection.extra.document_version ~ ' →' %} - {% endif %} -
-
- {{ subsection_title }} -
-
- {% endfor %} -
-
-
-
-
-
-{% endblock content %} diff --git a/themes/bluetheme b/themes/bluetheme new file mode 160000 index 0000000..5e7f7fa --- /dev/null +++ b/themes/bluetheme @@ -0,0 +1 @@ +Subproject commit 5e7f7fa46d78885206b959ac94cb7f0cc930c600