Documentation build system

.github/workflows/pages.yml

@@ -0,0 +1,34 @@
+name: Build Pages
+on:
+    push:
+        branches:
+            - main
+            - docs-setup
+    workflow_dispatch:
+jobs:
+  publish:
+    runs-on: ubuntu-20.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Setup
+        run: |
+            sudo apt update -q
+            sudo apt install -yy python python3-pip
+            pip install -r tools/requirements.txt
+      -
+        name: Docs
+        run: |
+            tools/mkdocs build -d site
+      -
+        name: Deploy to GitHub Pages
+        if: success()
+        uses: crazy-max/ghaction-github-pages@v2
+        with:
+          target_branch: gh-pages
+          build_dir: site
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.gitignore

@@ -0,0 +1,2 @@
+docs/lottie.schema.json
+site/

docs/governance/0._CS_Contributor_License_Agreement.md

@@ -0,0 +1 @@
+../../0._CS_Contributor_License_Agreement.md

docs/governance/1._Community_Specification_License-v1.md

@@ -0,0 +1 @@
+../../1._Community_Specification_License-v1.md

docs/governance/2._Scope.md

@@ -0,0 +1 @@
+../../2._Scope.md

docs/governance/3._Notices.md

@@ -0,0 +1 @@
+../../3._Notices.md

docs/governance/4._License.md

@@ -0,0 +1 @@
+../../4._License.md

docs/governance/5._Governance.md

@@ -0,0 +1 @@
+../../5._Governance.md

docs/governance/6._Contributing.md

@@ -0,0 +1 @@
+../../6._Contributing.md

docs/governance/8._Code_of_Conduct.md

@@ -0,0 +1 @@
+../../8._Code_of_Conduct.md

docs/governance/FAQ.md

@@ -0,0 +1 @@
+../../FAQ.md

docs/governance/Notices.md

@@ -0,0 +1 @@
+../../Notices.md

docs/index.md

@@ -0,0 +1 @@
+# Lottie Animation Format

docs/specs/assets.md

@@ -0,0 +1,16 @@
+# Assets
+
+## {schema_string:assets/asset/title}
+
+{schema_string:assets/asset/description}
+
+{schema_object:assets/asset}
+EXPAND:#/$defs/helpers/visual-object
+
+
+## {schema_string:assets/precomposition/title}
+
+{schema_string:assets/precomposition/description}
+
+{schema_object:assets/precomposition}
+EXPAND:#/$defs/composition/composition

docs/specs/composition.md

@@ -0,0 +1,18 @@
+# Composition
+
+
+## {schema_string:composition/animation/title}
+
+{schema_string:composition/animation/description}
+
+{schema_object:composition/animation}
+EXPAND:#/$defs/composition/composition
+EXPAND:#/$defs/helpers/visual-object
+
+
+## {schema_string:composition/composition/title}
+
+{schema_string:composition/composition/description}
+
+{schema_object:composition/composition}
+EXPAND:#/$defs/helpers/visual-object

docs/specs/constants.md

@@ -0,0 +1,148 @@
+# Enumerations
+
+<!--
+## {schema_string:constants/blend-mode/title}
+
+{schema_string:constants/blend-mode/description}
+
+{schema_enum:blend-mode}
+
+
+## {schema_string:constants/composite/title}
+
+{schema_string:constants/composite/description}
+
+{schema_enum:composite}
+-->
+
+## {schema_string:constants/fill-rule/title}
+
+{schema_string:constants/fill-rule/description}
+
+{schema_enum:fill-rule}
+
+
+<!--
+## {schema_string:constants/font-path-origin/title}
+
+{schema_string:constants/font-path-origin/description}
+
+{schema_enum:font-path-origin}
+
+
+## {schema_string:constants/gradient-type/title}
+
+{schema_string:constants/gradient-type/description}
+
+{schema_enum:gradient-type}
+
+
+## {schema_string:constants/line-cap/title}
+
+{schema_string:constants/line-cap/description}
+
+{schema_enum:line-cap}
+
+
+## {schema_string:constants/line-join/title}
+
+{schema_string:constants/line-join/description}
+
+{schema_enum:line-join}
+
+
+## {schema_string:constants/mask-mode/title}
+
+{schema_string:constants/mask-mode/description}
+
+{schema_enum:mask-mode}
+
+
+## {schema_string:constants/matte-mode/title}
+
+{schema_string:constants/matte-mode/description}
+
+{schema_enum:matte-mode}
+
+
+## {schema_string:constants/merge-mode/title}
+
+{schema_string:constants/merge-mode/description}
+
+{schema_enum:merge-mode}
+-->
+
+## {schema_string:constants/shape-direction/title}
+
+{schema_string:constants/shape-direction/description}
+
+{schema_enum:shape-direction}
+
+<!--
+## {schema_string:constants/star-type/title}
+
+{schema_string:constants/star-type/description}
+
+{schema_enum:star-type}
+
+
+## {schema_string:constants/stroke-dash-type/title}
+
+{schema_string:constants/stroke-dash-type/description}
+
+{schema_enum:stroke-dash-type}
+
+
+## {schema_string:constants/text-based/title}
+
+{schema_string:constants/text-based/description}
+
+{schema_enum:text-based}
+
+
+## {schema_string:constants/text-grouping/title}
+
+{schema_string:constants/text-grouping/description}
+
+{schema_enum:text-grouping}
+
+
+## {schema_string:constants/text-justify/title}
+
+{schema_string:constants/text-justify/description}
+
+{schema_enum:text-justify}
+
+
+## {schema_string:constants/text-shape/title}
+
+{schema_string:constants/text-shape/description}
+
+{schema_enum:text-shape}
+
+To better illustrate what the value mean, the graphics below shows an
+example for each value, including the function itself, based on the
+range start and end character.
+
+![Text Shapes](/lottie-spec/examples/text_shape.png)
+-->
+
+## {schema_string:constants/trim-multiple-shapes/title}
+
+{schema_string:constants/trim-multiple-shapes/description}
+
+{schema_enum:trim-multiple-shapes}
+
+<!--
+## {schema_string:constants/text-caps/title}
+
+{schema_string:constants/text-caps/description}
+
+{schema_enum:text-caps}
+
+## {schema_string:constants/text-range-units/title}
+
+{schema_string:constants/text-range-units/description}
+
+{schema_enum:text-range-units}
+-->

docs/specs/schema.md

@@ -0,0 +1,12 @@
+disable_toc: 1
+
+# JSON Schema
+
+
+This page shows a formatted version of the JSON schema, you can click on highlighted
+objects to get a link to that section of the schema. You can also click on `$ref`
+values to jump to the relevant section.
+
+If you want you can also view the [raw schema file](/lottie-spec/lottie.schema.json).
+
+{json_file:lottie.schema.json}

mkdocs.yml

@@ -0,0 +1,44 @@
+site_name: Lottie Specs
+site_description: Documentation for the Lottie animation format
+extra:
+    lottie_player_version: 5.12.2
+theme:
+    name: cinder
+    custom_dir: tools/theme
+    highlightjs: false
+repo_url: https://github.com/lottie-animation-community/lottie-spec
+edit_uri: https://github.com/lottie-animation-community/lottie-spec/edit/main/docs
+use_directory_urls: true
+site_url: https://lottie-animation-community.github.io/lottie-spec/
+markdown_extensions:
+    # - md_in_html
+    - lottie_markdown
+    # - footnotes
+extra_css:
+    # - /lottie-spec/style/style.css
+    # - /lottie-spec/style/lottie-theme.css
+plugins:
+    - search
+nav:
+    - "Home" : index.md
+    - "Format":
+        - specs/composition.md
+        - specs/layers.md
+        - specs/shapes.md
+        - specs/assets.md
+        - specs/constants.md
+        - specs/helpers.md
+        - specs/properties.md
+        #
+        - specs/schema.md
+    - "Community":
+        - governance/0._CS_Contributor_License_Agreement.md
+        - governance/1._Community_Specification_License-v1.md
+        - governance/2._Scope.md
+        - governance/3._Notices.md
+        - governance/4._License.md
+        - governance/5._Governance.md
+        - governance/6._Contributing.md
+        - governance/8._Code_of_Conduct.md
+        - governance/FAQ.md
+        - governance/Notices.md