Migrate Javascript docs to Hugo

.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
 bgdocs.code-workspace
+node_modules
+
 
 

.gitmodules

@@ -0,0 +1,4 @@
+
+[submodule "doc-site/themes/docsy"]
+	path = doc-site/themes/docsy
+	url = https://github.com/google/docsy

doc-site/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: '20:00'
+  open-pull-requests-limit: 10
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: '20:00'
+  open-pull-requests-limit: 10

doc-site/.gitignore

@@ -0,0 +1,6 @@
+/public
+resources/
+node_modules/
+package-lock.json
+.hugo_build.lock
+*.bak

doc-site/.nvmrc

@@ -0,0 +1 @@
+lts/*

doc-site/Dockerfile

@@ -0,0 +1,3 @@
+FROM klakegg/hugo:ext-alpine
+
+RUN apk add git

doc-site/assets/scss/_variables_project.scss

@@ -0,0 +1,6 @@
+/*
+
+Add styles or override variables from the theme here.
+
+*/
+

doc-site/config.toml

@@ -0,0 +1,233 @@
+baseURL = "https://yahoo.github.io/bgdocs/docs/typescript/"
+title = "Behavior Graph"
+
+ignoreFiles = ["community", "blog", "about", "docs2", "ignore", "\\.bak$"]
+
+enableRobotsTXT = true
+
+# Hugo allows theme composition (and inheritance). The precedence is from left to right.
+theme = ["docsy"]
+
+# Will give values to .Lastmod etc.
+enableGitInfo = true
+
+# Language settings
+contentDir = "content/en"
+defaultContentLanguage = "en"
+defaultContentLanguageInSubdir = false
+# Useful when translating.
+enableMissingTranslationPlaceholders = true
+
+# Comment out to enable taxonomies in Docsy
+# disableKinds = ["taxonomy", "taxonomyTerm"]
+
+# You can add your own taxonomies
+[taxonomies]
+tag = "tags"
+category = "categories"
+
+[params.taxonomy]
+# set taxonomyCloud = [] to hide taxonomy clouds
+taxonomyCloud = ["tags", "categories"] 
+
+# If used, must have same lang as taxonomyCloud
+taxonomyCloudTitle = ["Tag Cloud", "Categories"] 
+
+# set taxonomyPageHeader = [] to hide taxonomies on the page headers
+taxonomyPageHeader = ["tags", "categories"] 
+
+
+# Highlighting config
+pygmentsCodeFences = true
+pygmentsUseClasses = false
+# Use the new Chroma Go highlighter in Hugo.
+pygmentsUseClassic = false
+#pygmentsOptions = "linenos=table"
+# See https://help.farbox.com/pygments.html
+pygmentsStyle = "tango"
+
+# Configure how URLs look like per section.
+[permalinks]
+blog = "/:section/:year/:month/:day/:slug/"
+
+
+## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
+[blackfriday]
+plainIDAnchors = true
+hrefTargetBlank = true
+angledQuotes = false
+latexDashes = true
+
+# Image processing configuration.
+[imaging]
+resampleFilter = "CatmullRom"
+quality = 75
+anchor = "smart"
+
+[services]
+[services.googleAnalytics]
+# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
+#id = "UA-00000000-0"
+
+# Language configuration
+
+[languages]
+[languages.en]
+title = "Behavior Graph"
+description = "Behaior Graph Documentation"
+languageName ="English"
+# Weight used for sorting.
+weight = 1
+#[languages.no]
+#title = "Goldydocs"
+#description = "Docsy er operativsystem for skyen"
+#languageName ="Norsk"
+#contentDir = "content/no"
+#time_format_default = "02.01.2006"
+#time_format_blog = "02.01.2006"
+
+#[languages.fa]
+#title = "اسناد گلدی"
+#description = "یک نمونه برای پوسته داکسی"
+#languageName ="فارسی"
+#contentDir = "content/fa"
+#time_format_default = "2006.01.02"
+#time_format_blog = "2006.01.02"
+
+[markup]
+  [markup.goldmark]
+    [markup.goldmark.renderer]
+      unsafe = true
+  [markup.highlight]
+      # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
+      style = "tango"
+      # Uncomment if you want your chosen highlight style used for code blocks without a specified language
+      guessSyntax = "false"
+
+# Everything below this are Site Params
+
+[security]
+	[security.exec]
+		allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$', '^asciidoctor$']
+
+# Comment out if you don't want the "print entire section" link enabled.
+[outputs]
+section = ["HTML", "print", "RSS"]
+
+[params]
+copyright = "Yahoo"
+#privacy_policy = "https://policies.google.com/privacy"
+
+# First one is picked as the Twitter card image if not set on page.
+# images = ["images/project-illustration.png"]
+
+# Menu title if your navbar has a versions selector to access old versions of your site.
+# This menu appears only if you have at least one [params.versions] set.
+version_menu = "Releases"
+
+# Flag used in the "version-banner" partial to decide whether to display a 
+# banner on every page indicating that this is an archived version of the docs.
+# Set this flag to "true" if you want to display the banner.
+archived_version = false
+
+# The version number for the version of the docs represented in this doc set.
+# Used in the "version-banner" partial to display a version number for the 
+# current doc set.
+version = "1.0.0"
+
+# A link to latest version of the docs. Used in the "version-banner" partial to
+# point people to the main doc site.
+url_latest_version = "https://yahoo.github.io/bgdocs"
+
+# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
+#github_repo = "https://github.com/google/docsy-example"
+# An optional link to a related project repo. For example, the sibling repository where your product code lives.
+#github_project_repo = "https://github.com/google/docsy"
+
+# Specify a value here if your content directory is not in your repo's root directory
+# github_subdir = ""
+
+# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
+# or specify a new value if you want to reference another branch in your GitHub links
+# github_branch= "main"
+
+# Google Custom Search Engine ID. Remove or comment out to disable search.
+#gcs_engine_id = "d72aa9b2712488cc3"
+
+# Enable Algolia DocSearch
+algolia_docsearch = false
+
+# Enable Lunr.js offline search
+offlineSearch = false
+
+# Enable syntax highlighting and copy buttons on code blocks with Prism
+prism_syntax_highlighting = false
+
+# User interface configuration
+[params.ui]
+#  Set to true to disable breadcrumb navigation.
+breadcrumb_disable = false
+# Set to true to disable the About link in the site footer
+footer_about_disable = false
+# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
+navbar_logo = true
+# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
+navbar_translucent_over_cover_disable = false
+# Enable to show the side bar menu in its compact state.
+sidebar_menu_compact = false
+# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
+sidebar_search_disable = false
+
+# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
+# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
+# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
+# add "hide_feedback: true" to the page's front matter.
+[params.ui.feedback]
+enable = false
+# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
+#yes = 'Glad to hear it! Please <a href="https://github.com/yahoo/bgdocs/issues/new">tell us how we can improve</a>.'
+#no = 'Sorry to hear that. Please <a href="https://github.com/yahoo/bgdocs/issues/new">tell us how we can improve</a>.'
+
+# Adds a reading time to the top of each doc.
+# If you want this feature, but occasionally need to remove the Reading time from a single page, 
+# add "hide_readingtime: true" to the page's front matter
+[params.ui.readingtime]
+enable = false
+
+[params.links]
+# End user relevant links. These will show up on left side of footer and in the community page if you have one.
+#[[params.links.user]]
+	#name = "User mailing list"
+	#url = "https://example.org/mail"
+	#icon = "fa fa-envelope"
+        #desc = "Discussion and help from your fellow users"
+#[[params.links.user]]
+	#name ="Twitter"
+	#url = "https://example.org/twitter"
+	#icon = "fab fa-twitter"
+        #desc = "Follow us on Twitter to get the latest news!"
+#[[params.links.user]]
+	#name = "Stack Overflow"
+	#url = "https://example.org/stack"
+	#icon = "fab fa-stack-overflow"
+        #desc = "Practical questions and curated answers"
+# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
+#[[params.links.developer]]
+	#name = "GitHub"
+	#url = "https://github.com/google/docsy"
+	#icon = "fab fa-github"
+        #desc = "Development takes place here!"
+#[[params.links.developer]]
+	#name = "Slack"
+	#url = "https://example.org/slack"
+	#icon = "fab fa-slack"
+        #desc = "Chat with other project developers"
+#[[params.links.developer]]
+	#name = "Developer mailing list"
+	#url = "https://example.org/mail"
+	#icon = "fa fa-envelope"
+        #desc = "Discuss development issues around the project"
+
+[params.mermaid]
+	enable = true
+

doc-site/content/en/_index.md

@@ -0,0 +1,89 @@
+---
+title: "Behavior Graph"
+linkTitle: "Documentation"
+weight: 20
+type: "docs"
+
+cascade:
+- type: "blog"
+  # set to false to include a blog section in the section nav along with docs
+  toc_root: true
+  _target:
+    path: "/blog/**"
+- type: "docs"
+  _target:
+    path: "/**"
+    kind: "page"
+- type: "docs"
+  _target:
+    path: "/**"
+    kind: "section"
+---
+
+Behavior Graph is a software architecture and state management library. It greatly enhances your ability to write complex user facing software and control systems. Broadly speaking, it belongs to the category of libraries which includes Redux, MobX, Rx (Reactive Extensions), and XState. It works by providing a specialized unit of composition which we call the __behavior__. Behaviors are simple blocks of code together with their dependency relationships.
+
+## Is it any good?
+
+Yes
+
+## Highlights
+
+* Minimal boilerplate
+* Scales from the simple to the very complex
+* Incremental adoption: works alongside existing code and frameworks
+* Handles state, events, and effects all in one
+* Multi-platform (Javascript/Typescript, Kotlin, Objective-C, Swift)
+
+We developed Behavior Graph to address our own complexity challenges while building an iOS video playing library which is used internally throughout the suite of native Yahoo mobile apps. After years of development and production usage, it has proven to be incredibly competent at scale. We have since ported it to multiple languages including Javascript/Typescript. It is less than 1500 lines of code and contains no external dependencies.
+
+Behavior Graph will particularly appeal to anyone with a willingness to rethink how we write software applications.
+
+## What does it look like?
+
+The below block of code implements a simple counter using Behavior Graph.
+It can increment the counter or reset it back to zero.
+
+About 70% of the concepts you need to work with Behavior Graph are contained in this one example.
+
+<!-- Intro-1 -->
+{{< highlight javascript >}}
+this.increment = this.moment();
+this.reset = this.moment();
+this.counter = this.state(0);
+
+this.behavior()
+    .demands(this.increment, this.reset)
+    .supplies(this.counter)
+    .runs(this => {
+        if (this.increment.justUpdated) {
+            this.counter.update(this.counter.value + 1);
+        } else if (this.reset.justUpdated) {
+            this.counter.update(0);
+        }
+    });
+{{< /highlight >}}
+
+A typical Behavior Graph program consists of dozens or hundreds of behaviors like this, each with its own responsibilities.
+The Behavior Graph library then ensures these behaviors are correctly specified and runs them at the correct time and in the correct order.
+At scale this is shockingly effective.
+
+## Is it for me?
+
+Behavior Graph is a general purpose library which you can use to organize the event driven logic in any program.
+It should also be of interest to anyone with an interest in software engineering and architectures.
+
+Specifically if you are working on any of these categories, you should definitely consider it:
+
+* Web apps
+* Mobile apps
+* Desktop Applications
+* User Interfaces
+* Control Systems
+* Robots
+* Games
+
+## Learning Behavior Graph
+
+While there are only a handful of basic concepts in Behavior Graph, it does require a shift in thinking.
+We recommend you start with the [Quick Start]({{< ref quickstart >}}) then work through the [Tutorials]({{< ref "tutorials/tutorial-1" >}}).
+They will help you understand how the pieces fit together.