x_ite 8.0.0 → 8.3.0

package/docs/_config.yml

@@ -1,140 +1,333 @@
+# The Site Configuration
 
-#Theme docs
-#https://github.com/mmistakes/minimal-mistakes
-#https://github.com/mluerig/personal-homepage
-
-remote_theme: "mmistakes/minimal-mistakes"
-minimal_mistakes_skin: "air" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise", "default"
-
-# Site Settings
-locale: "en-US"
-title: &title "X_ITE X3D Browser"
-title_separator: "-"
-subtitle: "Ocean of Time and Space"
-name: &name "Holger Seelig"
-description: *name
-words_per_minute: 200
-github: [metadata]
-
-# Site Author
-author:
-  name: *title
-  avatar: "assets/images/logo.png"
-  bio: "Version 8.0.0"
-  links:
-    - label: "GitHub"
-      icon: "fab fa-2x fa-fw fa-github"
-      url: "https://github.com/create3000/x_ite"
+# Import the theme
+theme: jekyll-theme-chirpy
+
+# Change the following value to "/PROJECT_NAME" ONLY IF your site type is GitHub Pages Project sites
+# and doesn't have a custom domain.
+baseurl: "/x_ite"
+
+# The language of the webpage › http://www.lingoes.net/en/translator/langcode.htm
+# If it has the same name as one of the files in folder `_data/locales`, the layout language will also be changed,
+# otherwise, the layout language will use the default value of "en".
+lang: en
+
+
+# Change to your timezone › http://www.timezoneconverter.com/cgi-bin/findzone/findzone
+timezone:
+
+# jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md
+# ↓ --------------------------
+
+title: X_ITE X3D Browser               # the main title
+version: 8.3.0
+
+tagline: Step Into The Future          # it will display as the sub-title
+
+description: >-                        # used by seo meta and the atom feed
+  X_ITE X3D Browser, a framework for integrating and manipulating X3D and VRML scenes in HTML.
+
+# fill in the protocol & hostname for your site, e.g., "https://username.github.io"
+url: "https://create3000.github.io"
 
-footer:
+github:
+  username: create3000/x_ite            # change to your github username
+
+twitter:
+  username: web3dconsortium             # change to your twitter username
+
+social:
+  # Change to your full name.
+  # It will be displayed as the default author of the posts and the copyright owner in the Footer
+  name: Holger Seelig
+  email: holger.seelig@google.com         # change to your email address
   links:
-    - label: "GitHub"
-      icon: "fab fa-fw fa-github-square"
-      url: "https://github.com/create3000/x_ite"
-    - label: "D3 X3D"
-      icon: "fas fa-fw fa-link"
-      url: "https://github.com/jamesleesaunders/d3-x3d"
-    - label: "Titania X3D Editor"
-      icon: "fas fa-fw fa-link"
-      url: "https://github.com/create3000/titania/wiki"
-    - label: "Web3D.org"
-      icon: "fas fa-fw fa-link"
-      url: "https://www.web3d.org"
-
-# Search
-search: true
-search_full_content: true
-search_provider: google
-google:
-  search_engine_id: 36920ccf3f21ca6d5
-
-titles_from_headings:
-  enabled: false
-  strip_title: true
-  collections: true
-
-relative_links:
-  enabled: true
-  collections: true
-
-plugins:
-  - jekyll-paginate
-  - jekyll-sitemap
-  - jekyll-last-modified-at
-  - jekyll-gist
-  - jekyll-feed
-  - jekyll-include-cache
-  - jekyll-titles-from-headings
-  - jekyll-remote-theme
-  - jekyll-seo-tag
-  - jekyll-relative-links
-
-# Conversion
-encoding: "utf-8"
-markdown: kramdown
-highlighter: rouge
-lsi: false
-excerpt_separator: "\n\n"
-incremental: false
-
-# Markdown Processing
+    # The first element serves as the copyright owner"s link
+    - https://twitter.com/web3dconsortium # change to your twitter homepage
+    - https://github.com/create3000       # change to your github homepage
+    # Uncomment below to add more social links
+    # - https://www.facebook.com/username
+    # - https://www.linkedin.com/in/username
+
+google_site_verification:                 # fill in to your verification string
+
+# ↑ --------------------------
+# The end of `jekyll-seo-tag` settings
+
+google_analytics:
+  id:                 # fill in your Google Analytics ID
+  # Google Analytics page views report settings
+  pv:
+    proxy_endpoint:   # fill in the Google Analytics superProxy endpoint of Google App Engine
+    cache_path:       # the local PV cache data, friendly to visitors from GFW region
+
+# Prefer color scheme setting.
+#
+# Note: Keep empty will follow the system prefer color by default,
+# and there will be a toggle to switch the theme between dark and light
+# on the bottom left of the sidebar.
+#
+# Available options:
+#
+#     light  - Use the light color scheme
+#     dark   - Use the dark color scheme
+#
+theme_mode:   # [light|dark]
+
+# The CDN endpoint for images.
+# Notice that once it is assigned, the CDN url
+# will be added to all image (site avatar & posts" images) paths starting with "/"
+#
+# e.g. "https://cdn.com"
+img_cdn:
+
+# the avatar on sidebar, support local or CORS resources
+avatar: "assets/img/logo.png"
+
+# boolean type, the global switch for ToC in posts.
+toc: true
+
+comments:
+  active:         # The global switch for posts comments, e.g., "disqus".  Keep it empty means disable
+  # The active options are as follows:
+  disqus:
+    shortname:    # fill with the Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname
+  # utterances settings › https://utteranc.es/
+  utterances:
+    repo:         # <gh-username>/<repo>
+    issue_term:   # < url | pathname | title | ...>
+  # Giscus options › https://giscus.app
+  giscus:
+    repo:              # <gh-username>/<repo>
+    repo_id:
+    category:
+    category_id:
+    mapping:           # optional, default to "pathname"
+    input_position:    # optional, default to "bottom"
+    lang:              # optional, default to the value of `site.lang`
+    reactions_enabled: # optional, default to the value of `1`
+
+# Self-hosted static assets, optional › https://github.com/cotes2020/chirpy-static-assets
+assets:
+  self_host:
+    enabled:      # boolean, keep empty means false
+    # specify the Jekyll environment, empty means both
+    # only works if `assets.self_host.enabled` is "true"
+    env:          # [development|production]
+
+pwa:
+  enabled: true   # the option for PWA feature
+
+paginate:
+
+# ------------ The following options are not recommended to be modified ------------------
+
 kramdown:
-  input: GFM
-  hard_wrap: false
-  auto_ids: true
-  footnote_nr: 1
-  entity_output: as_char
-  toc_levels: 1..6
-  smart_quotes: lsquo,rsquo,ldquo,rdquo
-  enable_coderay: false
-
-# Sass/SCSS
-sass:
-  sass_dir: _sass
-  style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
+  syntax_highlighter: rouge
+  syntax_highlighter_opts:   # Rouge Options › https://github.com/jneen/rouge#full-options
+    css_class: highlight
+    # default_lang: console
+    span:
+      line_numbers: false
+    block:
+      line_numbers: true
+      start_line: 1
+
+collections:
+  tabs:
+    output: true
+    sort_by: order
 
-# Defaults
 defaults:
+  - scope:
+      path: ""          # An empty string here means all files in the project
+      type: posts
+    values:
+      layout: x_ite
+      comments: true    # Enable comments in posts.
+      toc: true         # Display TOC column in posts.
+      # DO NOT modify the following parameter unless you are confident enough
+      # to update the code of all other post links in this project.
+      permalink: /:slugified_categories/:slug
+  - scope:
+      path: _drafts
+    values:
+      comments: false
   - scope:
       path: ""
-      type: pages
+      type: tabs             # see `site.collections`
     values:
-      layout: single
-      classes: wide
-      author_profile: true
-      sidebar:
-        nav: pages
+      layout: page
+      permalink: /:title/
   - scope:
-      path: "reference"
-      type: pages
+      path: assets/img/favicons
     values:
-      layout: single
-      classes: wide
-      author_profile: true
-      sidebar:
-        nav: reference
+      swcache: true
   - scope:
-      path: "tutorials"
-      type: pages
+      path: assets/js/dist
     values:
-      layout: single
-      classes: wide
-      author_profile: true
-      sidebar:
-        nav: tutorials
-
-# Fiels and folders
-include:
-  - 404.md
-  - Accessing-the-External-Browser.md
-  - Browser-Support.md
-  - Custom-Shaders.md
-  - Features.md
-  - Glossary.md
-  - How-To-Configure-Your-Web-Server.md
-  - Supported-Nodes.md
-  - What's-New.md
-  - DOM-Integration.md
-  - index.md
-  - reference
-  - tutorials
+      swcache: true
+
+sass:
+  style: compressed
+
+compress_html:
+  clippings: all
+  comments: all
+  endings: all
+  profile: false
+  blanklines: false
+  ignore:
+    envs: [x-development]
+
+exclude:
+  - "*.gem"
+  - "*.gemspec"
+  - tools
+  - README.md
+  - CHANGELOG.md
+  - LICENSE
+  - gulpfile.js
+  - node_modules
+  - package*.json
+
+jekyll-archives:
+  enabled: [categories, tags]
+  layouts:
+    category: category
+    tag: tag
+  permalinks:
+    tag: /tags/:name/
+    category: /categories/:name/
+
+nav:
+  main:
+    - title: "Quick-Start Guide"
+      children:
+        - title: "Getting Started"
+          url: /
+        - title: "What's New"
+          url: /what-s-new
+        - title: "Features"
+          url: /features
+        - title: "Browser Support"
+          url: /browser-support
+        - title: "Supported Nodes"
+          url: /supported-nodes
+        - title: "Accessing the External Browser"
+          url: /accessing-the-external-browser
+        - title: "DOM Integration"
+          url: /dom-integration
+        - title: "Custom Shaders"
+          url: /custom-shaders
+        - title: "Setup a localhost Server"
+          url: /setup-a-localhost-server
+        - title: "How To Configure Your Web Server"
+          url: /how-to-configure-your-web-server
+        - title: "Glossary"
+          url: /glossary
+        - title: "Report a Bug"
+          url: /report-a-bug
+  reference:
+    - title: "JavaScript Reference"
+      children:
+        - title: "Script Node Authoring Interface"
+          url: /reference/script-node-authoring-interface
+        - title: "ECMAScript Object and Function Definitions"
+          url: /reference/ecmascript-object-and-function-definitions
+        - title: "Browser Services"
+          url: /reference/browser-services
+        - title: "Scene Services"
+          url: /reference/scene-services
+        - title: "Field Services and Objects"
+          url: /reference/field-services-and-objects
+        - title: "Route Services"
+          url: /reference/route-services
+        - title: "Prototype Services"
+          url: /reference/prototype-services
+        - title: "Constants Services"
+          url: /reference/constants-services
+  tutorials-basic:
+    - title: "Basic Tutorials"
+      children:
+        - title: "Hello, World!"
+          url: /tutorials/hello-world
+        - title: "Basic Nodes"
+          url: /tutorials/basic-nodes
+  tutorials-shapes-geometry-and-appearance:
+    - title: "Shapes, Geometry, and Appearance"
+      children:
+        - title: "Introducing X3D"
+          url: /tutorials/introducing-x3d
+        - title: "Building a X3D World"
+          url: /tutorials/building-a-x3d-world
+        - title: "Building Primitive Shapes"
+          url: /tutorials/building-primitive-shapes
+        - title: "Transforming Shapes"
+          url: /tutorials/transforming-shapes
+        - title: "Controlling Appearance with Materials"
+          url: /tutorials/controlling-appearance-with-materials
+        - title: "Grouping Nodes"
+          url: /tutorials/grouping-nodes
+        - title: "Naming Nodes"
+          url: /tutorials/naming-nodes
+  tutorials-animation-sensors-and-geometry:
+    - title: "Animation, Sensors, and Geometry"
+      children:
+        - title: "Introducing Animation"
+          url: /tutorials/introducing-animation
+        - title: "Animating Transforms"
+          url: /tutorials/animating-transforms
+        - title: "Sensing Viewer Actions"
+          url: /tutorials/sensing-viewer-actions
+        - title: "Building Shapes out of Points, Lines, and Faces"
+          url: /tutorials/building-shapes-out-of-points-lines-and-faces
+        - title: "Building Elevation Grids"
+          url: /tutorials/building-elevation-grids
+        - title: "Building Extruded Shapes"
+          url: /tutorials/building-extruded-shapes
+        - title: "Controlling Color on Coordinate-Based Geometry"
+          url: /tutorials/controlling-color-on-coordinate-based-geometry
+        - title: "Controlling Shading on Coordinate-Based Geometry"
+          url: /tutorials/controlling-shading-on-coordinate-based-geometry
+  tutorials-textures-lights-and-environment:
+    - title: "Textures, Lights, and Environment"
+      children:
+        - title: "Mapping Textures"
+          url: /tutorials/mapping-textures
+        - title: "Controlling How Textures are Mapped"
+          url: /tutorials/controlling-how-textures-are-mapped
+        - title: "Lighting Your World"
+          url: /tutorials/lighting-your-world
+        - title: "Adding Backgrounds"
+          url: /tutorials/adding-backgrounds
+        - title: "Adding Fog"
+          url: /tutorials/adding-fog
+        - title: "Adding Sound"
+          url: /tutorials/adding-sound
+        - title: "Controlling the Viewpoint"
+          url: /tutorials/controlling-the-viewpoint
+        - title: "Controlling Navigation"
+          url: /tutorials/controlling-navigation
+        - title: "Sensing the Viewer"
+          url: /tutorials/sensing-the-viewer
+  tutorials-scripts-and-prototypes:
+    - title: "Scripts and Prototypes"
+      children:
+        - title: "Controlling Detail"
+          url: /tutorials/controlling-detail
+        - title: "Introducing Script Use"
+          url: /tutorials/introducing-script-use
+        - title: "Writing Program Scripts with ECMAScript"
+          url: /tutorials/writing-program-scripts-with-ecmascript
+        - title: "Creating New Node Types"
+          url: /tutorials/creating-new-node-types
+        - title: "Providing Information About Your World"
+          url: /tutorials/providing-information-about-your-world
+  tutorials-optimize-your-scene:
+    - title: "Optimize Your Scene"
+      children:
+        - title: "Improving Performance"
+          url: /tutorials/improving-performance
+        - title: "Increasing Rendering Speed"
+          url: /tutorials/increasing-rendering-speed

package/docs/_data/assets/cross_origin.yml

@@ -0,0 +1,62 @@
+# CDNs
+
+cdns:
+  # Google Fonts
+  - url: https://fonts.googleapis.com
+  - url: https://fonts.gstatic.com
+    args: crossorigin
+  - url: https://fonts.googleapis.com
+  # jsDelivr CDN
+  - url: https://cdn.jsdelivr.net
+
+# fonts
+
+webfonts: https://fonts.googleapis.com/css2?family=Lato&family=Source+Sans+Pro:wght@400;600;700;900&display=swap
+
+# Libraries
+
+jquery:
+  js: https://cdn.jsdelivr.net/npm/jquery@3/dist/jquery.min.js
+
+bootstrap:
+  css: https://cdn.jsdelivr.net/npm/bootstrap@4/dist/css/bootstrap.min.css
+  js: https://cdn.jsdelivr.net/npm/bootstrap@4/dist/js/bootstrap.bundle.min.js
+
+bootstrap-toc:
+  css: https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@1.0.1/dist/bootstrap-toc.min.css
+  js: https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@1.0.1/dist/bootstrap-toc.min.js
+
+fontawesome:
+  css: https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6/css/all.min.css
+
+search:
+  js: https://cdn.jsdelivr.net/npm/simple-jekyll-search@1.10.0/dest/simple-jekyll-search.min.js
+
+mermaid:
+  js: https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.min.js
+
+dayjs:
+  js:
+    common: https://cdn.jsdelivr.net/npm/dayjs@1/dayjs.min.js
+    locale: https://cdn.jsdelivr.net/npm/dayjs@1/locale/:LOCALE.min.js
+    relativeTime: https://cdn.jsdelivr.net/npm/dayjs@1/plugin/relativeTime.min.js
+    localizedFormat: https://cdn.jsdelivr.net/npm/dayjs@1/plugin/localizedFormat.min.js
+
+countup:
+  js: https://cdn.jsdelivr.net/npm/countup.js@1.9.3/dist/countUp.min.js
+
+magnific-popup:
+  css: https://cdn.jsdelivr.net/npm/magnific-popup@1/dist/magnific-popup.min.css
+  js: https://cdn.jsdelivr.net/npm/magnific-popup@1/dist/jquery.magnific-popup.min.js
+
+lozad:
+  js: https://cdn.jsdelivr.net/npm/lozad/dist/lozad.min.js
+
+clipboard:
+  js: https://cdn.jsdelivr.net/npm/clipboard@2/dist/clipboard.min.js
+
+polyfill:
+  js: https://polyfill.io/v3/polyfill.min.js?features=es6
+
+mathjax:
+  js: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js

package/docs/_data/assets/self_host.yml

@@ -0,0 +1,51 @@
+# fonts
+
+webfonts: /assets/lib/fonts/main.css
+
+# Libraries
+
+jquery:
+  js: /assets/lib/jquery-3.6.0/jquery.min.js
+
+bootstrap:
+  css: /assets/lib/bootstrap-4.6.1/bootstrap.min.css
+  js: /assets/lib/bootstrap-4.6.1/bootstrap.bundle.min.js
+
+bootstrap-toc:
+  css: /assets/lib/bootstrap-toc-1.0.1/bootstrap-toc.min.css
+  js: /assets/lib/bootstrap-toc-1.0.1/bootstrap-toc.min.js
+
+fontawesome:
+  css: /assets/lib/fontawesome-free-6.2.1/css/all.min.css
+
+search:
+  js: /assets/lib/simple-jekyll-search-1.10.0/simple-jekyll-search.min.js
+
+mermaid:
+  js: /assets/lib/mermaid-9.1.7/mermaid.min.js
+
+dayjs:
+  js:
+    common: /assets/lib/dayjs-1.10.7/dayjs.min.js
+    locale: /assets/lib/dayjs-1.10.7/locale/en.min.js
+    relativeTime: /assets/lib/dayjs-1.10.7/plugin/relativeTime.min.js
+    localizedFormat: /assets/lib/dayjs-1.10.7/plugin/localizedFormat.min.js
+
+countup:
+  js: /assets/lib/countup.js-1.9.3/countUp.min.js
+
+magnific-popup:
+  css: /assets/lib/magnific-popup-1.1.0/magnific-popup.css
+  js: /assets/lib/magnific-popup-1.1.0/jquery.magnific-popup.min.js
+
+lozad:
+  js: /assets/lib/lozad-1.16.0/lozad.min.js
+
+clipboard:
+  js: /assets/lib/clipboard-2.0.9/clipboard.min.js
+
+polyfill:
+  js: /assets/lib/polyfill-v3-es6/polyfill.min.js
+
+mathjax:
+  js: /assets/lib/mathjax-3.2.0/tex-chtml.js

package/docs/_data/contact.yml

@@ -0,0 +1,30 @@
+#  The contact options.
+
+-
+  type: github
+  icon: 'fab fa-github'
+-
+  type: twitter
+  icon: 'fab fa-twitter'
+-
+  type: email
+  icon: 'fas fa-envelope'
+  noblank: true            # open link in current tab
+-
+  type: rss
+  icon: 'fas fa-rss'
+  noblank: true
+
+# Uncomment and complete the url below to enable more contact options
+# -
+#   type: mastodon
+#   icon: 'fab fa-mastodon'   # icons powered by <https://fontawesome.com/>
+#   url:  ''                  # Fill with your mastodon account page
+# -
+#   type: linkedin
+#   icon: 'fab fa-linkedin'   # icons powered by <https://fontawesome.com/>
+#   url:  ''                  # Fill with your Linkedin homepage
+# -
+#   type: stack-overflow
+#   icon: 'fab fa-stack-overflow'
+#   url:  ''                  # Fill with your stackoverflow homepage