diff --git a/GITHUB_PAGES.md b/GITHUB_PAGES.md deleted file mode 100644 index 4fd09a1..0000000 --- a/GITHUB_PAGES.md +++ /dev/null @@ -1,269 +0,0 @@ -# Editing and Publishing the GitHub Pages Website - -The [published website](https://the-ai-alliance.github.io/REPO_NAME/). - -The documentation for this repo is published using [GitHub Pages](https://pages.github.com/). We welcome contributions as PRs. See the AI Alliance [CONTRIBUTING](https://github.com/The-AI-Alliance/community/blob/main/CONTRIBUTING.md) instructions. Also, you'll need to agree with the AI Alliance [Code of Conduct](https://github.com/The-AI-Alliance/community/blob/main/CODE_OF_CONDUCT.md) and all contributions will be covered by the [LICENSE](https://github.com/The-AI-Alliance/community/blob/main/LICENSE) (which is also in [this repo](LICENSE)). - -> [!NOTE] -> The documentation in this repo is licensed under Creative Commons Attribution 4.0 International. To view a copy of this license, see [LICENSE.CC-BY-4.0](LICENSE.CC-BY-4.0) or visit https://creativecommons.org/licenses/by/4.0/legalcode. All code uses the [Apache 2.0](LICENSE.Apache-2.0) license. All data uses the [CDLA 2.0](LICENSE.CDLA-2.0) license. - - -## Quick Setup - -We use [GitHub Pages](https://pages.github.com/) so edits can be made in Markdown, updates can be managed using pull requests, and the results can be published automatically by GitHub. - -In fact, each page has _Edit this page on GitHub_ links, making it easy to view a page, then go straight to the source to edit it and submit a PR! This is the best way to help us fix typos and make similar small edits. - -However, this easy approach only supports correcting content on a single page. for more significant changes, like adding new pages, you may want the ability to preview the changes locally. - -Local previewing allows you to see how any changes, even on a single page, will _really_ look when rendered with stylesheets, etc. While GitHub renders Markdown well, there are extensions we use that are supported by Jekyll that won't be rendered correctly in GitHub's default Markdown file viewer. - -> [!NOTE] -> If you don't want to setup `jekyll` for previewing or if you have trouble setting it up, don't let that stop you from contributing content! Submit a PR with your changes and we'll review them in a running environment ourselves. We'll provide feedback as needed. - -So, to view the website locally and to make more extensive changes, you'll need to have a recent version of [Ruby](https://www.ruby-lang.org/en/) installed, along with the [`gem`](https://docs.ruby-lang.org/en/master/Gem.html) library management tool, and [`jekyll`](https://jekyllrb.com/) which is the webserver and rendering engine. - -We discuss these steps in more depth [below](#setup-jekyll), but the following steps may _just work_ for you. - -Install a recent version of Ruby 3. Note that on MacOS, the default Ruby installation is old, version 2.6.10. Installing Ruby will also install the `gem` dependency tool. - -This project's `Makefile` will attempt to install the remaining dependencies, including `jekyll`, when you run `make all` or `make view-local`. - -> [!WARNING] -> The automatic setup of `jekyll` in the `Makefile` has only been tested on MacOS and it most likely doesn't work on Windows, unless you use the Linux subsystem. If you encounter problems on other platforms, please [post an issue](https://github.com/The-AI-Alliance/REPO_NAME/issues) to get help, or if you can fix the issue, a [pull request](https://github.com/The-AI-Alliance/REPO_NAME/pulls) (PR) is always welcome :nerd_face:. (More details on PRs below.) - -So, try `make view-local` and see if Jekyll is installed successfully and the website is rendered. - -The command will finish with a message like this: - -``` -... -Server address: http://127.0.0.1:4000/ -Server running... press ctrl-c to stop. -``` - -Open the URL in a browser. - -> [!TIP] -> -> 1. On MacOS, use ⌘-click on the URL to open it in a browser. -> 2. Run `make help` for a list of the main commands defined. -> 3. Run `JEKYLL_PORT=4444 make view-local` to use port `4444` instead of `4000`. -> 4. `view-local` will always check the Ruby and Jekyll installation. To skip this, use `make run-jekyll` instead. - -## Contributing New or Improved Content - -What gets displayed by GitHub Pages is the customized Markdown files in the `docs` directory. If you need to create a new page, copy an existing page to get the correct "header" information, then edit as needed. - -Here are some things you should know. - -### Using the Correct Branch - -As for most Git projects, issue PRs to the `main` branch. However, the repo is actually configured to publish the docs from the `latest` branch, so we can accept PRs quickly, then decide when to publish a new version. (We will also tag `latest` for each release with a version number, for historical tracking.) - -> [!NOTE] -> If you are curious, the details of how this publication branch is configured are discussed [below](#configuring-github-pages-in-the-repo-settings). - -## Publishing a New Version - -Because PRs go to the `main` branch, but the pages are published from the `latest` branch, PRs are not immediately published. When it is time to publish a new version of the website, change to the `main` git branch and run the script `./publish-website.sh`. It takes several options: - -```shell -> publish-website.sh -h -publish-website.sh [-h|--help] [-n|--noop] [-v|--version V] [-t|--timestamp T] - -Where the options are the following: --h | --help Print this message and exit --n | --noop Just print the commands but don't make changes. --v | --version V Use version string "V", which should be of the format - "X.Y.Z". Without this option the current value of - "last_version" in _config.yml is extracted (e.g., 1.0.1) - and the last digit is incremented. --t | --timestamp "T" Use this timestamp "T", which you'll need to quote on - the command line, because it MUST be of the form - "%Y-%m-%d %H:%M %z". Without this option, the current - system time is used. -``` - -With no arguments, the current version string's last digit will be incremented. For example, if the current version is `1.2.3`, the new version with be `1.2.4`. _Please use this `X.Y.Z` format if you specify a new version explicitly._ The script doesn't check the format. - -The script _does_ check that a specified timestamp uses the correct format, but it should be rare that you would want to use any timestamp other than the current time, which is the default. - -Both strings are printed at the bottom of each page, e.g.: - -``` -Version: 1.0.1. Site last modified: Jun 5 2024 08:13 -0500. -``` - -> **TIP:** Verify this worked! You should see the new version information in three places: -> -> * `docs/config.yml`: `last_modified_timestamp` and `last_version`. -> * `docs/index.markdown`: **Last Update** table row near the top, **Version History** near the bottom. -` - -## Editing Conventions and Tips - -### Links - -For internal cross-references, use the conventional `[title]({{site.baseurl}}/relative_URL)` Markdown syntax. - -> [!WARNING] -> the `{{site.baseurl}}/` prefix is _essential_, because this _prefix_ will be different for local execution vs. published serving. - - -For external links (those that start with `http` or `https`), we use the [`jekyll-target-blank` plugin](https://github.com/keithmifsud/jekyll-target-blank) to automatically open them in a new browser tab or window. _Relative_ links within the site are opened in the same tab. - -This plugin effectively adds `target="_blank"` to every anchor tag, i.e., `...`. However, this means that if users click on a lot of external links to see all of them, they will be "stacked" in the history of one browser tab. Therefore, you may consider adding explicit targets yourself. You can do this using the following syntax: - -```markdown -[`jekyll-target-blank` plugin](https://github.com/keithmifsud/jekyll-target-blank){:target="arbitrary_name"} -``` - -Furthermore, as a visual clue to the user, [our stylesheet](https://github.com/The-AI-Alliance/REPO_NAME/blob/main/docs/_includes/css/custom.scss.liquid) is configured to put little up-and-to-the-right arrows after every external link. This provides a visual clue that a new tab will be opened. - -### Emojis - -In the pages, you can use emojis, e.g., `:+1:` yields :+1:, `:smirk:` yields :smirk:, `:nerd_face:` yields :nerd_face:, etc. The `jemoji` Ruby gem adds this capability. [Here is a list of available emojis](https://www.webfx.com/tools/emoji-cheat-sheet/). - -## Previewing Your Work Locally - -We provided a basic set of instructions above for setting up Jekyll locally. Here is a more detailed set of instructions, if you need them. - -### Setup Jekyll - -First, you'll need a reasonably recent version of Ruby installed. The one that comes with MacOS is _not new enough_. See [Use Homebrew to Install Ruby on MacOS](#use-homebrew-to-install-ruby-on-macos) to install [Homebrew](https://brew.sh) and then Ruby using the `brew` command. - -Afterwards, the commands shown next should produce similar output that shown from Dean's machine, circa June 2024: - -```shell -$ which ruby -/usr/local/Cellar/ruby/3.3.0/bin/ruby -$ ruby --version -ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [x86_64-darwin23] -``` - -> [!WARNING] -> In 2022, when we used these tools, building the website was not working with Ruby 3.2, you may still need to use 3.3 or 3.1. - -For MacOS, make sure the `ruby` path shown is not `/usr/bin/ruby`, which is the old, built-in 2.6 version. Try `which -a ruby`, which will hopefully show the `Cellar` version second. If so, edit the `PATH` definition in your `~/.zshrc` file to put the newer `/usr/local/Cellar/ruby/3.X.Y/bin` directory before `/usr/bin/`. - -Now, it _should_ be sufficient to run the following command: - -```shell -make setup-jekyll -``` - -If this fails, then see the [Tips and Known Issues](#tips-and-known-issues) below. - -### View the Pages Locally - -Once Jekyll is set up, you can serve the pages locally for previewing and editing by running one of the following commands, then open [localhost:4000](http://localhost:4000) (default port...) in a browser: - -```shell -make view-local # Install all Jekyll dependencies, then make "run-jekyll" -make run-jekyll # Run the jekyll server. Avoids dependency setup every time! -JEKYLL_PORT=4444 make view-local # Use a different port, 4444 instead of 4000 -JEKYLL_PORT=4444 make run-jekyll -``` - -If an error is thrown, see the [Tips and Known Issues](#tips-and-known-issues) below. - -> [!TIP] -> -> 1. On MacOS, use ⌘-click on the URL to open it in a browser. -> 2. Run `make help` for a list of the main commands defined. - -The `run-jekyll` target runs the following command: - -```shell -cd docs && bundle exec jekyll serve --port ${JEKYLL_PORT} --baseurl '' --incremental -``` - -* `JEKYLL_PORT` for the `--port` flag defaults to `4000` -* The `--baseurl` flag effectively supports the simple URL, `localhost:$JEKYLL_PORT`. (Without it, the URL would be `localhost:$JEKYLL_PORT/The-AI-Alliance/REPO_NAME/`.) -* The `--incremental` flag lets you edit the pages and refresh the browser tab to see the updates immediately. - -> [!NOTE] -> Well, more or less immediately. It can take several seconds for new pages to be generated and sometimes you'll get weird behaviors if you change URL paths, etc. So, occasionally it is useful to _control-c_ in the terminal and rerun the `make` command. - -> [!TIP] -> `make view-pages` opens the _published_ GitHub Pages in a browser tab. - -### Now Edit! - -You can now edit the pages, save them, then refresh your browser to see the updates. - -## Tips and Known Issues - -### Use Homebrew to Install Ruby on MacOS (Recommended) - -You really can't use the Ruby that comes with your Mac, because: -1. It's too old, 2.6.X, instead of 3.X, which we need. -2. You don't have permissions to install Gems into `/Library/...` - -So, install [Homebrew](https://brew.sh), if you haven't already. Then use it to install a local, recent version of Ruby: - -```shell -brew install ruby@3.3 -which -a ruby -``` - -If the last command shows `/usr/bin/ruby` before a path like `/usr/local/Cellar/ruby/3.3.0/bin/ruby`, then you will have to edit your `~/.zshrc` file and make sure the `/usr/local/Cellar/ruby/...` path comes before `/usr/bin`. For example, the following line will just put this Ruby first. (this is a hack): - -```shell -PATH="/usr/local/opt/ruby/3.3.0/bin:$PATH" -``` - -(Use the exact version number you have!) - -Then in your terminal, either open a new window/tab or run the command `source ~/.zshrc` to load the changed `PATH`. Now `which ruby` should return a path in `/usr/local/Cellar/...` and `ruby --version` should return the correct 3.X version. - -### The Jekyll Installation Instructions Failed - -Suppose you run the following command and it fails: - -```shell -make setup-jekyll # also executed when making `view-local` -``` - -First, make sure you are using a valid version of `ruby`. A symptom you didn't do that; you'll see this error message: - -``` -You don't have write permissions for the /Library/Ruby/Gems/2.6.0 directory. -``` - -The commands run by `make setup-jekyll` include the following (a few details omitted for simplification): - -```shell -gem install bundler jekyll jemoji -bundle install -bundle update html-pipeline -``` - -Finally, if you are still stuck, please [post an issue](https://github.com/The-AI-Alliance/REPO_NAME/issues) to get help. - -> **Help Needed:** -> -> If you find missing steps that `make setup-jekyll` should run but doesn't, or you find and fix problems that only occur on non-MacOS platforms, **please** submit a PR with fixes! Thank you. - -### The "make view-local" Command Fails - -What if `make view-local` command fails with this error message? - -```shell -jekyll 3.9.2 | Error: No such file or directory @ rb_check_realpath_internal -``` - -First, that's an old Jekyll version. It should be 4.3.3 or later. Try these commands: - -```shell -gem uninstall jekyll -gem install jekyll -gem list | grep jekyll -``` - -### Configuring GitHub Pages in the Repo Settings - -This section documents the one-time settings changes we did to [configure publication of our GitHub Pages](https://docs.github.com/en/enterprise-server@3.1/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). We changed the desired branch to use, `latest`, rather than the default `main` branch, and we specified the directory for the website pages, `docs`. This only needs to be done if and when the branch or directory location is changed. - -In the repo's [_Settings > Pages_ section](https://github.com/The-AI-Alliance/REPO_NAME/settings/pages), set the branch to be `latest` and the folder to be `/docs`. The reason for using `latest` rather than `main`, is to allow small change PRs to be made without affecting what is published until we decide to publish an update. diff --git a/Gemfile b/Gemfile deleted file mode 100644 index 10b7929..0000000 --- a/Gemfile +++ /dev/null @@ -1,58 +0,0 @@ -source "https://rubygems.org" -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! - -# gem "github-pages", "~> 225", group: :jekyll_plugins -# gem "github-pages", group: :jekyll_plugins - -# gem "jekyll", "~> 3.9.0" -# gem "jekyll", "~> 4.2.2" - -# This is the default theme for new Jekyll sites. You may change this to anything you like. -gem "minima", "~> 2.5" - -# If you want to use GitHub Pages, remove the "gem "jekyll"" above and -# uncomment the line below. To upgrade, run `bundle update github-pages`. -gem "github-pages", "~> 231", group: :jekyll_plugins - -# If you have any plugins, put them here! -# group :jekyll_plugins do - # gem "jekyll-feed", "= 0.17.0" - # gem "jekyll-feed", "= 0.15.1" - # gem "jekyll-feed", "~> 0.12" -# end - -# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem -# and associated library. -platforms :mingw, :x64_mingw, :mswin, :jruby do - gem "tzinfo", "~> 2.0" - gem "tzinfo-data" -end - -# Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] - -# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem -# do not have a Java counterpart. -# gem "http_parser.rb", "~> 0.8.0", :platforms => [:jruby] - -gem "webrick", "~> 1.8" - -# Security fixes: -gem "nokogiri", ">= 1.16" -#gem "html-pipeline", ">= 3.0.0.pre1" - -# Bug fixes -gem "liquid", ">= 4.0.4" - -# No longer included in Ruby as of 3.4 -gem "csv" - -# Target blank automatically opens all links in a new window. -gem 'jekyll-target-blank' diff --git a/Makefile b/Makefile deleted file mode 100644 index a76bff9..0000000 --- a/Makefile +++ /dev/null @@ -1,156 +0,0 @@ - -pages_url := https://the-ai-alliance.github.io/REPO_NAME/ -docs_dir := docs -site_dir := ${docs_dir}/_site -clean_dirs := ${site_dir} ${docs_dir}/.sass-cache - -# Environment variables -MAKEFLAGS = -w # --warn-undefined-variables -MAKEFLAGS_RECURSIVE ?= # --print-directory (only useful for recursive makes...) -UNAME ?= $(shell uname) -ARCHITECTURE ?= $(shell uname -m) - -# Override when running `make view-local` using e.g., `JEKYLL_PORT=8000 make view-local` -JEKYLL_PORT ?= 4000 - -# Used for version tagging release artifacts. -GIT_HASH ?= $(shell git show --pretty="%H" --abbrev-commit |head -1) -NOW ?= $(shell date +"%Y%m%d-%H%M%S") - -define help_message -Quick help for this make process. - -make all # Clean and locally view the document. -make clean # Remove built artifacts, etc. -make view-pages # View the published GitHub pages in a browser. -make view-local # View the pages locally (requires Jekyll). - # Tip: "JEKYLL_PORT=8000 make view-local" uses port 8000 instead of 4000! - -Miscellaneous tasks for help, debugging, setup, etc. - -make help # Prints this output. -make print-info # Print the current values of some make and env. variables. -make setup-jekyll # Install Jekyll. Make sure Ruby is installed. - # (Only needed for local viewing of the document.) -make run-jekyll # Used by "view-local"; assumes everything is already built. - # Tip: "JEKYLL_PORT=8000 make run-jekyll" uses port 8000 instead of 4000! -endef - -define missing_shell_command_error_message -is needed by ${PWD}/Makefile. Try 'make help' and look at the README. -endef - -ifndef docs_dir -$(error ERROR: There is no ${docs_dir} directory!) -endif - -define gem-error-message - -ERROR: Did the gem command fail with a message like this? -ERROR: "You don't have write permissions for the /Library/Ruby/Gems/2.6.0 directory." -ERROR: To run the "gem install ..." command for the MacOS default ruby installation requires "sudo". -ERROR: Instead, use Homebrew (https://brew.sh) to install ruby and make sure "/usr/local/.../bin/gem" -ERROR: is on your PATH before "user/bin/gem". -ERROR: -ERROR: Or did the gem command fail with a message like this? -ERROR: Bundler found conflicting requirements for the RubyGems version: -ERROR: In Gemfile: -ERROR: foo-bar (>= 3.0.0) was resolved to 3.0.0, which depends on -ERROR: RubyGems (>= 3.3.22) -ERROR: -ERROR: Current RubyGems version: -ERROR: RubyGems (= 3.3.11) -ERROR: In this case, try "brew upgrade ruby" to get a newer version. - -endef - -define bundle-error-message - -ERROR: Did the bundle command fail with a message like this? -ERROR: "/usr/local/opt/ruby/bin/bundle:25:in `load': cannot load such file -- /usr/local/lib/ruby/gems/3.1.0/gems/bundler-X.Y.Z/exe/bundle (LoadError)" -ERROR: Check that the /usr/local/lib/ruby/gems/3.1.0/gems/bundler-X.Y.Z directory actually exists. -ERROR: If not, try running the clean-jekyll command first: -ERROR: make clean-jekyll setup-jekyll -ERROR: Answer "y" (yes) to the prompts and ignore any warnings that you can't uninstall a "default" gem. - -endef - -define missing_ruby_gem_or_command_error_message -is needed by ${PWD}/Makefile. Try "gem install ..." -endef - -define ruby_and_gem_required_message -'ruby' and 'gem' are required. See ruby-lang.org for installation instructions. -endef - -define gem_required_message -Ruby's 'gem' is required. See ruby-lang.org for installation instructions. -endef - - -.PHONY: all view-pages view-local clean help -.PHONY: setup-jekyll run-jekyll - -all:: clean view-local - -help:: - $(info ${help_message}) - @echo - -print-info: - @echo "GitHub Pages URL: ${pages_url}" - @echo "current dir: ${PWD}" - @echo "docs dir: ${docs_dir}" - @echo "site dir: ${site_dir}" - @echo "clean dirs: ${clean_dirs} (deleted by 'make clean')" - @echo - @echo "MAKEFLAGS: ${MAKEFLAGS}" - @echo "MAKEFLAGS_RECURSIVE: ${MAKEFLAGS_RECURSIVE}" - @echo "JEKYLL_PORT: ${JEKYLL_PORT}" - @echo "UNAME: ${UNAME}" - @echo "ARCHITECTURE: ${ARCHITECTURE}" - @echo "GIT_HASH: ${GIT_HASH}" - @echo "NOW: ${NOW}" - -clean:: - rm -rf ${clean_dirs} - -view-pages:: - @python -m webbrowser "${pages_url}" || \ - (echo "ERROR: I could not open the GitHub Pages URL. Try ⌘-click or ^-click on this URL instead:" && \ - echo "ERROR: ${pages_url}" && exit 1 ) - -view-local:: setup-jekyll run-jekyll - -# Passing --baseurl '' allows us to use `localhost:4000` rather than require -# `localhost:4000/The-AI-Alliance/REPO_NAME` when running locally. -run-jekyll: clean - @echo - @echo "Once you see the http://127.0.0.1:${JEKYLL_PORT}/ URL printed, open it with command+click..." - @echo - cd ${docs_dir} && bundle exec jekyll serve --port ${JEKYLL_PORT} --baseurl '' --incremental || ( echo "ERROR: Failed to run Jekyll. Try running 'make setup-jekyll'." && exit 1 ) - -setup-jekyll:: ruby-installed-check bundle-ruby-command-check - @echo "Updating Ruby gems required for local viewing of the docs, including jekyll." - gem install jekyll bundler jemoji || ${MAKE} gem-error - bundle install || ${MAKE} bundle-error - bundle update html-pipeline || ${MAKE} bundle-error - -ruby-installed-check: - @command -v ruby > /dev/null || \ - ( echo "ERROR: ${ruby_and_gem_required_message}" && exit 1 ) - @command -v gem > /dev/null || \ - ( echo "ERROR: ${gem_required_message}" && exit 1 ) - -%-error: - $(error ${${@}-message}) - -%-ruby-command-check: - @command -v ${@:%-ruby-command-check=%} > /dev/null || \ - ( echo "ERROR: Ruby command/gem ${@:%-ruby-command-check=%} ${missing_ruby_gem_or_command_error_message}" && \ - exit 1 ) - -%-shell-command-check: - @command -v ${@:%-shell-command-check=%} > /dev/null || \ - ( echo "ERROR: shell command ${@:%-shell-command-check=%} ${missing_shell_command_error_message}" && \ - exit 1 ) diff --git a/README-template.md b/README-template.md deleted file mode 100644 index fe16d85..0000000 --- a/README-template.md +++ /dev/null @@ -1,137 +0,0 @@ -# How to Use `microsite-template` - -This repo is used as a template to create AI Alliance “microsites”. It is setup as a GitHub _template repo_, which you can use to create a new repo. Even if you aren't creating a microsite, you can use this procedure to create a new AI Alliance repo for other purposes. - -## Creating Your Repo - -These are the main steps: - -1. Create your repo from the [this template repo](https://github.com/The-AI-Alliance/microsite-template). -1. Convert placeholder _variables_ to the correct values, using the [`finish-microsite.sh`](https://github.com/The-AI-Alliance/microsite-template/blob/main/finish-microsite.sh) script. -1. Add your initial content for the repo. -1. Merge changes to the `latest` branch. -1. Push all updates upstream, `git push --all`. -1. On the repo's home page in GitHub, click the "gear" next to "About" (upper right-hand side). In the _Edit repository details_ that pops up, check the box to _Use your GitHub Pages website_ and enter appropriate _Topics_. -1. Add the website to the Alliance GitHub organization [landing page](https://github.com/The-AI-Alliance/) and the Alliance GitHub Pages [website](https://the-ai-alliance.github.io/#the-ai-alliance-projects). -1. When finished, delete this file! - -> [!NOTE] -> We are planning to automate as many of the manual steps as we can. - -Let's look at these steps in more detail. - -### 1. Create your repo from the `microsite-template`. - -Pick a name for your new repo and follow [these GitHub instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) to create a new repo from the [`microsite-template`](https://github.com/The-AI-Alliance/microsite-template) repo. - -### 2. Convert the placeholder _variables_. - -After step 1., your repo will have placeholder values for the project name, etc. Next, change to the repo root directory and run the script [`finish-microsite.sh`](https://github.com/The-AI-Alliance/microsite-template/blob/main/finish-microsite.sh) to replace the placeholder _variables_ with appropriate strings for your project. - -> [!WARN] -> The `finish-microsite.sh` script uses `zsh`. If you don't have `zsh` available, then use `bash` version 5 or later, e.g., `bash finish-microsite.sh ...`. - -At the time of this writing, here are the required arguments shown with example values for a repo named `ai-for-evil-project` under the auspices of the _FA2 Trust and Safety_ focus area work group: - -```shell -./finish-microsite.sh \ - --microsite-title "AI for Evil Project" \ - --work-group fa2 -``` - -Referring to a focus area, like `fa2` or `FA2` is expanded as follows: - -| Abbreviation | Full name | -| :----------- | :-------- | -| `FA1` | FA1: Skills and Education | -| `FA2` | FA2: Trust and Safety | -| `FA3` | FA3: Applications and Tools | -| `FA4` | FA4: Hardware Enablement | -| `FA5` | FA5: Foundation Models and Datasets | -| `FA6` | FA6: Advocacy | - -> [!NOTE] -> 1. Run the script with `zsh`, **_not_** `bash`. -> 2. To see the current list of required arguments and optional argument, run the script with the `--help` flag. - -> [!WARN] -> After running the script, your changes are only in your local repo, not pushed upstream. We'll fix that in step 5 below. - -### 3. Add your initial content for the repo. - -> [!NOTE] -> If you are creating a repo for code, not a microsite, delete the `docs` directory, but do the following steps that make sense. - -There are other placeholder texts in the `docs/**/*.markdown`, README, and other files that you should replace with your real content as soon as possible, e.g., - -1. Find and replace all occurrences of `TODO` with appropriate content. -1. Rename or delete the `second_page.markdown`. Copy it to add more top-level pages, but change the `nav_order` field to control the order of the pages shown in the left-hand side navigation view. -> [!TIP] -> Start with `10`, `20`, etc. for the `nav_order` of top-level pages, giving yourself room to insert new pages in between existing pages. For nested pages, e.g., under `20`, use `210`, `220`, etc. -3. See the `nested` directory content as an example of how to do nesting, or delete it if you don't need it. Note the metadata fields at the top, such as the `parent` and `has_children` fields. -4. Make any changes you want to make in the `docs/_config.yml` file. (None are mandatory.) - -For more tips and guidance on development tasks, see also the links for more information in the `README.md` in your new repo. Add a project-specific description at the beginning of that file. - -### 4. Merge changes to the `latest` branch. - -> [!NOTE] -> If you are creating a repo for code, not a microsite, delete the `latest` branch: -> -> ```shell -> git br -D latest -> ``` -> -> Also delete the upstream branch in the GitHub page for your repo. Then ignore the following steps. - -As discussed in [`GITHUB_PAGES.md`](https://github.com/The-AI-Alliance/the-ai-alliance.github.io/blob/main/GITHUB_PAGES.md), by default we publish the "microsite" from the `latest` branch, using `main` as the pre-publishing integration branch. Assuming you made all the edits above on the `main` branch, merge them to `latest`. - -```shell -git checkout latest -git merge main -``` - -### 5. Push all updates upstream. - -Run the following command: - -```shell -git push --all -``` - -Adding `--all` pushes the `main` and `latest` branches upstream. - -### 6. Add Your website to the Alliance GitHub Pages and the Alliance Website. - -> [!NOTE] -> If you are creating a repo for code, not a microsite, ignore this section. - -When you are ready for broader exposure for your site, there are a few places where we have an index to all the “microsites”. Add your site in the table shown in each of the following locations. Note how the rows are grouped by focus area. Put your new row with the others in your focus area. - -* https://github.com/The-AI-Alliance/.github/blob/main/profile/README.md -* https://github.com/The-AI-Alliance/the-ai-alliance.github.io/blob/main/docs/index.markdown - -You can just edit the page directly in GitHub and submit a PR. Note that for the second link, the `index.markdown` page for the `the-ai-alliance.github.io` site, we add `{:target="..."}` annotations to each link. Just use a unique name for your links. - -Finally, talk to your focus area leaders about updating the [AI Alliance website](https://thealliance.ai) with information about your project site. - -### 7. When finished, delete this file - -This file is no longer needed, so you can remove it from your repo: - -```shell -git rm README-template.md -``` - -If you are building a microsite and have the `latest` branch: - -```shell -git checkout latest -git merge main -``` - -Finally, push upstream: - -```shell -git push --all -``` diff --git a/README_orig.md b/README_orig.md deleted file mode 100644 index cf20563..0000000 --- a/README_orig.md +++ /dev/null @@ -1,41 +0,0 @@ -# README for MICROSITE_TITLE - -[Published Documentation](https://the-ai-alliance.github.io/REPO_NAME/) - -This repo contains the code and documentation for the AI Alliance: MICROSITE_TITLE. - -See the [repo README](https://the-ai-alliance.github.io/REPO_NAME/) for additional details about this project. - -TODO - Describe this project - -## Quick Tip - View the Website Locally - -See [GITHUB_PAGES.md](GITHUB_PAGES.md) for information on viewing the site locally with `jekyll`. - -## Getting Involved - -We welcome contributions as PRs. Please see our [Alliance community repo](https://github.com/The-AI-Alliance/community/) for general information about contributing to any of our projects. This section provides some specific details you need to know. - -In particular, see the AI Alliance [CONTRIBUTING](https://github.com/The-AI-Alliance/community/blob/main/CONTRIBUTING.md) instructions. You will need to agree with the AI Alliance [Code of Conduct](https://github.com/The-AI-Alliance/community/blob/main/CODE_OF_CONDUCT.md). - -All _code_ contributions are licensed under the [Apache 2.0 LICENSE](https://github.com/The-AI-Alliance/community/blob/main/LICENSE.Apache-2.0) (which is also in this repo, [LICENSE.Apache-2.0](LICENSE.Apache-2.0)). - -All _documentation_ contributions are licensed under the [Creative Commons Attribution 4.0 International](https://github.com/The-AI-Alliance/community/blob/main/LICENSE.CC-BY-4.0) (which is also in this repo, [LICENSE.CC-BY-4.0](LICENSE.CC-BY-4.0)). - -All _data_ contributions are licensed under the [Community Data License Agreement - Permissive - Version 2.0](https://github.com/The-AI-Alliance/community/blob/main/LICENSE.CDLA-2.0) (which is also in this repo, [LICENSE.CDLA-2.0](LICENSE.CDLA-2.0)). - -### We use the "Developer Certificate of Origin" (DCO). - -> [!WARNING] -> Before you make any git commits with changes, understand what's required for DCO. - -See the Alliance contributing guide [section on DCO](https://github.com/The-AI-Alliance/community/blob/main/CONTRIBUTING.md#developer-certificate-of-origin) for details. In practical terms, supporting this requirement means you must use the `-s` flag with your `git commit` commands. - -## About the GitHub Pages Website Published from this Repo - -The website is published using [GitHub Pages](https://pages.github.com/), where the pages are written in Markdown and served using [Jekyll](https://github.com/jekyll/jekyll). We use the [Just the Docs](https://just-the-docs.github.io/just-the-docs/) Jekyll theme. - -See [GITHUB_PAGES.md](GITHUB_PAGES.md) for more information. - -> [!NOTE] -> As described above, all documentation is licensed under Creative Commons Attribution 4.0 International. See [LICENSE.CDLA-2.0](LICENSE.CDLA-2.0)). diff --git a/docs/.prettierignore b/docs/.prettierignore deleted file mode 100644 index 53a4aa2..0000000 --- a/docs/.prettierignore +++ /dev/null @@ -1,11 +0,0 @@ -package.json -package-lock.json -_site -assets/css/just-the-docs-default.scss -assets/css/just-the-docs-light.scss -assets/css/just-the-docs-dark.scss -assets/js/vendor/lunr.min.js -assets/js/search-data.json -assets/js/just-the-docs.js -*.md -*.markdown diff --git a/docs/.prettierrc b/docs/.prettierrc deleted file mode 100644 index 70175ce..0000000 --- a/docs/.prettierrc +++ /dev/null @@ -1,7 +0,0 @@ -{ - "endOfLine": "lf", - "semi": false, - "singleQuote": false, - "tabWidth": 2, - "trailingComma": "es5" -} \ No newline at end of file diff --git a/docs/.stylelintrc.json b/docs/.stylelintrc.json deleted file mode 100644 index 329ca34..0000000 --- a/docs/.stylelintrc.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "ignoreFiles": [ - "assets/css/just-the-docs-default.scss", - "assets/css/just-the-docs-light.scss", - "assets/css/just-the-docs-dark.scss", - "_sass/vendor/**/*.scss" - ], - "extends": ["stylelint-config-primer", "stylelint-config-prettier"], - "plugins": ["stylelint-prettier"], - "rules": { - "prettier/prettier": true - } -} diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index 8ea5c12..0000000 --- a/docs/404.html +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: 404 -permalink: /404 -nav_exclude: true -search_exclude: true ---- - -

Page not found

- -

The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to the home page.

diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 13cc3e4..0000000 --- a/docs/_config.yml +++ /dev/null @@ -1,138 +0,0 @@ -# Welcome to Jekyll! -# -# This config file is meant for settings that affect your whole site, values -# which you are expected to set up once and rarely edit after that. If you find -# yourself editing these this file very often, consider using Jekyll's data files -# feature for the data you need to update frequently. -# -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'jekyll serve'. If you change this file, please restart the server process. - -# Site settings -# These are used to personalize your new site. If you look in the HTML files, -# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on. -# You can create any custom variable you would like, and they will be accessible -# in the templates via {{ site.myvariable }}. -title: MICROSITE_TITLE -email: contact@thealliance.ai -description: >- # this means to ignore newlines until "baseurl:" - The website for the AI Alliance project, MICROSITE_TITLE. -baseurl: "/REPO_NAME" # the subpath of your site. -url: "https://the-ai-alliance.github.io" # the base hostname & protocol for your site, e.g. http://example.com - -permalink: pretty -exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile", "Makefile" -, "docs/tests/", "notes.md", "vendor" -] - -# Regression tests -# By default, the pages in /docs/tests are excluded when the site is built. -# To include them, comment-out the relevant line above. -# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791 -# include: ["docs/tests/"] - -# Set a path/url to a logo that will be displayed instead of the title -#logo: "/assets/images/just-the-docs.png" - -# Enable or disable the site search -# Supports true (default) or false -search_enabled: true -search: - # Split pages into sections that can be searched individually - # Supports 1 - 6, default: 2 - heading_level: 6 - # Maximum amount of previews per search result - # Default: 3 - previews: 3 - # Maximum amount of words to display before a matched word in the preview - # Default: 5 - preview_words_before: 3 - # Maximum amount of words to display after a matched word in the preview - # Default: 10 - preview_words_after: 3 - # Set the search token separator - # Default: /[\s\-/]+/ - # Example: enable support for hyphenated search words - tokenizer_separator: /[\s/]+/ - # Display the relative url in search results - # Supports true (default) or false - rel_url: true - # Enable or disable the search button that appears in the bottom right corner of every page - # Supports true or false (default) - button: false - -# Enable or disable heading anchors -heading_anchors: true - -# Aux links for the upper right navigation -aux_links: - "The AI Alliance": - - "https://thealliance.ai" - -nav_external_links: - - title: The AI Alliance repo for MICROSITE_TITLE" - url: "https://github.com/The-AI-Alliance/REPO_NAME" - hide_icon: false - -# Makes Aux links open in a new tab. Default is false -aux_links_new_tab: true - -# Sort order for navigation links -# nav_sort: case_insensitive # default, equivalent to nil -nav_sort: case_sensitive # Capital letters sorted before lowercase - -# Footer content -# appears at the bottom of every page's main content - -# Back to top link -back_to_top: true -back_to_top_text: "Back to the top" - -# Footer last edited timestamp -last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter -last_edit_time_format: "%Y-%m-%d %H:%M %z" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html -last_modified_timestamp: TIMESTAMP -last_version: 0.1.0 - -# "Edit this page on GitHub" link text -gh_edit_link: true # show or hide edit this page link -gh_edit_link_text: "Edit this page on GitHub" -gh_edit_repository: "https://github.com/The-AI-Alliance/REPO_NAME/tree/latest/docs" # the github URL for your repo -gh_edit_branch: "target-blank" # the branch that your docs is served from -gh_edit_source: "docs" # the source that your files originate from -gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately - -# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define -color_scheme: nil - -# Google Analytics Tracking (optional) -# e.g, UA-1234567-89 -ga_tracking: G-RNHLN944B5 -#ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default) - -plugins: - - jekyll-seo-tag - - jekyll-target-blank - - jemoji - -kramdown: - highlighter: rouge - syntax_highlighter_opts: - block: - line_numbers: false - -compress_html: - clippings: all - comments: all - endings: all - startings: [] - blanklines: false - profile: false - # ignore: - # envs: all - -mermaid: - # Version of mermaid library - # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/ - version: "9.1.5" - diff --git a/docs/_includes/css/custom.scss.liquid b/docs/_includes/css/custom.scss.liquid deleted file mode 100644 index e555976..0000000 --- a/docs/_includes/css/custom.scss.liquid +++ /dev/null @@ -1,87 +0,0 @@ -@import "./custom/custom"; - -// The following trick is from -// https://christianoliff.com/blog/styling-external-links-with-an-icon-in-css/ -// It automatically adds the "external link" glyph -// at the end of all non-relative URLs. This DOES NOT -// cause them to be opened in separate windows; for that -// the anchor tag has to contain a target="foo". -div.main-content a[href^="http"]::after, -div.main-content a[href^="https://"]::after -{ - content: ""; - width: 11px; - height: 11px; - margin-left: 4px; - background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' viewBox='0 0 16 16'%3E%3Cpath fill-rule='evenodd' d='M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z'/%3E%3Cpath fill-rule='evenodd' d='M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z'/%3E%3C/svg%3E"); - background-position: center; - background-repeat: no-repeat; - background-size: contain; - display: inline-block; -} - -// Add the class "no-glyph" to links where you don't want the glyph added, -// like images that are links. -div.main-content a[href^="http"].no-glyph::after, -div.main-content a[href^="https://"].no-glyph::after -{ - background-image: none !important ; - width: 0px !important; -} - -// This doesn't actually work. Instead, the child-page ToC -// just uses the child.url, but NOT child.url | absolute.url. -// This causes the generated links to be relative, whereas -// for some reason when child.url | absolute.url is used, -// the absolute.url wins and a full URL is inserted. -div.child-pages-toc a[href^="http://example.com"]::after -div.child-pages-toc a[href^="https://example.com"]::after -{ - display: none !important; -} - -.disabled { - background-color: grey; - opacity: 0.5; -} - -.bold { - font-weight: bold -} - -// A "box" around that can be used for a different kind of callout. -div.callout-box { - background: #F0F0F8; - margin: 5px; - padding: 5px; - border: 1px solid #8080F8; -} - -// Similar to div.callout-box -table, th, td { - // background: #F0F0F8; - // margin: 5px; - padding: 5px; - // border: 2px solid #8080F8; -} -td { - background: #F0F0F8; -} - -// Center divs and images -div.centered { - text-align: center; -} -img.centered { - margin: auto; - display: block -} - -// Style figure captions -p.caption { - font-size: 80%; - font-style: italic; -} - -.resizer { display:flex; margin:0; padding:0; resize:both; overflow:hidden } -.resizer > .resized { flex-grow:1; margin:0; padding:0; border:0 } diff --git a/docs/_includes/css/just-the-docs.scss.liquid b/docs/_includes/css/just-the-docs.scss.liquid deleted file mode 100644 index 495cd6d..0000000 --- a/docs/_includes/css/just-the-docs.scss.liquid +++ /dev/null @@ -1,7 +0,0 @@ -{% if site.logo %} -$logo: "{{ site.logo | absolute_url }}"; -{% endif %} -@import "./support/support"; -@import "./color_schemes/{{ include.color_scheme }}"; -@import "./modules"; -{% include css/custom.scss.liquid %} diff --git a/docs/_includes/fix_linenos.html b/docs/_includes/fix_linenos.html deleted file mode 100644 index 6243fb0..0000000 --- a/docs/_includes/fix_linenos.html +++ /dev/null @@ -1,65 +0,0 @@ -{%- comment -%} -This file can be used to fix the HTML produced by Jekyll for highlighted -code with line numbers. - -It works with `{% highlight some_language linenos %}...{% endhighlight %}` -and with the Kramdown option to add line numbers to fenced code. - -The implementation was derived from the workaround provided by -Dmitry Hrabrov (DeXP) at -https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-188144901 - -EXPLANATION - -The HTML produced by Rouge highlighting with lie numbers is of the form -`code table`. Jekyll (<= 4.1.1) always wraps the highlighted HTML -with `pre`. This wrapping is not only unnecessary, but also transforms -the conforming HTML produced by Rouge to non-conforming HTML, which -results in HTML validation error reports. - -The fix removes the outer `pre` tags whenever they contain the pattern -``. - -Apart from avoiding HTML validation errors, the fix allows the use of -the [Jekyll layout for compressing HTML](http://jch.penibelst.de), -which relies on `pre` tags not being nested, according to -https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-172069842 - -USAGE - -(Any names can be used for `some_var` and `some_language`.) - -{% capture some_var %} -{% highlight some_language linenos %} -Some code -{% endhighlight %} -{% endcapture %} -{% include fix_linenos.html code=some_var %} - -For code fences: - -{% capture some_var %} -```some_language -Some code -``` -{% endcapture %} -{% assign some_var = some_var | markdownify %} -{% include fix_linenos.html code=some_var %} - -CAVEATS - -The above does not work when `Some code` happens to contain the matched string -`
`. - -The use of this file overwrites the variable `fix_linenos_code` with `nil`. - -{%- endcomment -%} - -{% assign fix_linenos_code = include.code %} -{% if fix_linenos_code contains '
' %} - {% assign fix_linenos_code = fix_linenos_code | replace: '
', '
' %}
-  {% assign fix_linenos_code = fix_linenos_code | replace: "
", "" %}
-{% endif %}
-{{ fix_linenos_code }}
-{% assign fix_linenos_code = nil %}
diff --git a/docs/_includes/footer_custom.html b/docs/_includes/footer_custom.html
deleted file mode 100644
index 64e08c2..0000000
--- a/docs/_includes/footer_custom.html
+++ /dev/null
@@ -1,3 +0,0 @@
-{%- if site.footer_content -%}
-  
{{ site.footer_content }}

-{%- endif -%}
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
deleted file mode 100644
index 5500a1c..0000000
--- a/docs/_includes/head.html
+++ /dev/null
@@ -1,40 +0,0 @@
-
-  
-  
-
-  {% unless site.plugins contains "jekyll-seo-tag" %}
-    {{ page.title }} - {{ site.title }}
-
-    {% if page.description %}
-      
-    {% endif %}
-  {% endunless %}
-
-  
-
-  
-
-  {% if site.ga_tracking != nil %}
-    
-    
-
-  {% endif %}
-
-  {% if site.search_enabled != false %}
-    
-  {% endif %}
-  
-
-  
-
-  {% seo %}
-
-  {% include head_custom.html %}
-
-
diff --git a/docs/_includes/head_custom.html b/docs/_includes/head_custom.html
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/_includes/header_custom.html b/docs/_includes/header_custom.html
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/_includes/js/custom.js b/docs/_includes/js/custom.js
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/_includes/mermaid_config.js b/docs/_includes/mermaid_config.js
deleted file mode 100644
index 6eded14..0000000
--- a/docs/_includes/mermaid_config.js
+++ /dev/null
@@ -1,4 +0,0 @@
-// _includes/mermaid_config.js
-{
-  theme: "forest"
-}
diff --git a/docs/_includes/nav.html b/docs/_includes/nav.html
deleted file mode 100644
index 325a68c..0000000
--- a/docs/_includes/nav.html
+++ /dev/null
@@ -1,99 +0,0 @@
-
diff --git a/docs/_includes/title.html b/docs/_includes/title.html
deleted file mode 100644
index 8bd3fa8..0000000
--- a/docs/_includes/title.html
+++ /dev/null
@@ -1,5 +0,0 @@
-{% if site.logo %}
-  
-{% else %}
-  {{ site.title }}
-{% endif %}
diff --git a/docs/_includes/vendor/anchor_headings.html b/docs/_includes/vendor/anchor_headings.html
deleted file mode 100755
index e9ca862..0000000
--- a/docs/_includes/vendor/anchor_headings.html
+++ /dev/null
@@ -1,144 +0,0 @@
-{% capture headingsWorkspace %}
-  {% comment %}
-    Copyright (c) 2018 Vladimir "allejo" Jimenez
-
-    Permission is hereby granted, free of charge, to any person
-    obtaining a copy of this software and associated documentation
-    files (the "Software"), to deal in the Software without
-    restriction, including without limitation the rights to use,
-    copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the
-    Software is furnished to do so, subject to the following
-    conditions:
-
-    The above copyright notice and this permission notice shall be
-    included in all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-    OTHER DEALINGS IN THE SOFTWARE.
-  {% endcomment %}
-  {% comment %}
-    Version 1.0.7
-      https://github.com/allejo/jekyll-anchor-headings
-
-    "Be the pull request you wish to see in the world." ~Ben Balter
-
-    Usage:
-      {% include anchor_headings.html html=content anchorBody="#" %}
-
-    Parameters:
-      * html          (string) - the HTML of compiled markdown generated by kramdown in Jekyll
-
-    Optional Parameters:
-      * beforeHeading (bool)   : false  - Set to true if the anchor should be placed _before_ the heading's content
-      * anchorAttrs   (string) :  ''    - Any custom HTML attributes that will be added to the `` tag; you may NOT use `href`, `class` or `title`;
-                                          the `%heading%` and `%html_id%` placeholders are available
-      * anchorBody    (string) :  ''    - The content that will be placed inside the anchor; the `%heading%` placeholder is available
-      * anchorClass   (string) :  ''    - The class(es) that will be used for each anchor. Separate multiple classes with a space
-      * anchorTitle   (string) :  ''    - The `title` attribute that will be used for anchors
-      * h_min         (int)    :  1     - The minimum header level to build an anchor for; any header lower than this value will be ignored
-      * h_max         (int)    :  6     - The maximum header level to build an anchor for; any header greater than this value will be ignored
-      * bodyPrefix    (string) :  ''    - Anything that should be inserted inside of the heading tag _before_ its anchor and content
-      * bodySuffix    (string) :  ''    - Anything that should be inserted inside of the heading tag _after_ its anchor and content
-
-    Output:
-      The original HTML with the addition of anchors inside of all of the h1-h6 headings.
-  {% endcomment %}
-
-  {% assign minHeader = include.h_min | default: 1 %}
-  {% assign maxHeader = include.h_max | default: 6 %}
-  {% assign beforeHeading = include.beforeHeading %}
-  {% assign nodes = include.html | split: '
-    {% if headerLevel == 0 %}
-      
-      {% assign firstChunk = node | split: '>' | first %}
-
-      
-      {% unless firstChunk contains '<' %}
-        {% capture node %}{% endcapture %}
-    {% assign _workspace = node | split: _closingTag %}
-    {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
-    {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
-    {% assign html_id = _idWorkspace[0] %}
-
-    {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
-    {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
-
-    
-    {% capture anchor %}{% endcapture %}
-
-    {% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
-      {% capture anchor %}href="#{{ html_id }}"{% endcapture %}
-
-      {% if include.anchorClass %}
-        {% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
-      {% endif %}
-
-      {% if include.anchorTitle %}
-        {% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %}
-      {% endif %}
-
-      {% if include.anchorAttrs %}
-        {% capture anchor %}{{ anchor }} {{ include.anchorAttrs | replace: '%heading%', header | replace: '%html_id%', html_id }}{% endcapture %}
-      {% endif %}
-
-      {% capture anchor %}{{ include.anchorBody | replace: '%heading%', header | default: '' }}{% endcapture %}
-
-      
-      {% if beforeHeading %}
-        {% capture anchor %}{{ anchor }} {% endcapture %}
-      {% else %}
-        {% capture anchor %} {{ anchor }}{% endcapture %}
-      {% endif %}
-    {% endif %}
-
-    {% capture new_heading %}
-      
-    {% endcapture %}
-
-    
-    {% assign chunkCount = _workspace | size %}
-    {% if chunkCount > 1 %}
-      {% capture new_heading %}{{ new_heading }}{{ _workspace | last }}{% endcapture %}
-    {% endif %}
-
-    {% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
-  {% endfor %}
-{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}
diff --git a/docs/_layouts/about.html b/docs/_layouts/about.html
deleted file mode 100644
index 5e71126..0000000
--- a/docs/_layouts/about.html
+++ /dev/null
@@ -1,5 +0,0 @@
----
-layout: default
----
-
-{{ content }}
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
deleted file mode 100644
index b4c95c7..0000000
--- a/docs/_layouts/default.html
+++ /dev/null
@@ -1,225 +0,0 @@
----
-layout: table_wrappers
----
-
-
-
-
-{% include head.html %}
-
-  
-    
-      Link
-      
-        
-      
-    
-    
-      Search
-      
-        
-      
-    
-    
-      Menu
-      
-        
-      
-    
-    
-      Expand
-      
-        
-      
-    
-    
-      Document
-      
-        
-      
-    
-  
-
-  

-    

-      {% include title.html %}
-      
-        
-      
-    

-    
-    
-  

-  

-    

-      {% if site.search_enabled != false %}
-        

-          

-            
-            
-          

-          

-        

-      {% endif %}
-      {% include header_custom.html %}
-      {% if site.aux_links %}
-        
-      {% endif %}
-    

-    

-      {% unless page.url == "/" %}
-        {% if page.parent %}
-          {%- for node in pages_list -%}
-            {%- if node.parent == nil -%}
-              {%- if page.parent == node.title or page.grand_parent == node.title -%}
-                {%- assign first_level_url = node.url | absolute_url -%}
-              {%- endif -%}
-              {%- if node.has_children -%}
-                {%- assign children_list = pages_list | where: "parent", node.title -%}
-                {%- for child in children_list -%}
-                  {%- if page.url == child.url or page.parent == child.title -%}
-                    {%- assign second_level_url = child.url | absolute_url -%}
-                  {%- endif -%}
-                {%- endfor -%}
-              {%- endif -%}
-            {%- endif -%}
-          {%- endfor -%}
-
-          
-        {% endif %}
-      {% endunless %}
-      

-        AI Alliance Banner
-        

-
-        {% if site.heading_anchors != false %}
-          {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
-        {% else %}
-          {{ content }}
-        {% endif %}
-          
-        {% if page.has_children == true and page.has_toc != false %}
-          

-          

-            
Child Pages

-            
    
-              {%- assign children_list = pages_list | where: "parent", page.title | where: "grand_parent", page.parent -%}
-              {% for child in children_list %}
-                {% if child.nav_exclude != true %}
-                
  • 
-                  {{child.title}}{% if child.summary %} - {{child.summary}}{% endif %} 
-                
    • 
-                {% endif %}
-              {% endfor %}
-            

-          

-        {% endif %}
-
-        {% capture footer_custom %}
-          {%- include footer_custom.html -%}
-        {% endcapture %}
-        {% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
-          

-          

-            {% if site.back_to_top %}
-              
{{ site.back_to_top_text }}

-            {% endif %}
-
-            {{ footer_custom }}
-            {% if site.last_edit_timestamp or site.gh_edit_link %}
-              {% if
-                site.gh_edit_link and
-                site.gh_edit_link_text and
-                site.gh_edit_repository and
-                site.gh_edit_branch and
-                site.gh_edit_view_mode
-              %}
-                

-                  

-                    {{ site.gh_edit_link_text }}
-                  

-                

-              {% endif %}
-              {% if site.last_edit_timestamp and site.last_edit_time_format %}
-                

-                  

-                    {% if site.last_version %}
-                      Version: {{ site.last_version }}
-                    {% endif %}
-                    {% if page.last_modified_date %}
-                      Page last modified: {{ page.last_modified_date | date: site.last_edit_time_format }}.
-                    {% elsif site.last_modified_date %}
-                      Site last modified: {{ site.last_modified_date | date: site.last_edit_time_format }}.
-                    {% endif %}
-                  

-                

-              {% endif %}
-            {% endif %}
-          

-        {% endif %}
-
-      

-    

-
-    {% if site.search_enabled != false %}
-      {% if site.search.button %}
-        
-          
-        
-      {% endif %}
-
-      

-    {% endif %}
-  

-
-
diff --git a/docs/_layouts/home.html b/docs/_layouts/home.html
deleted file mode 100644
index 5e71126..0000000
--- a/docs/_layouts/home.html
+++ /dev/null
@@ -1,5 +0,0 @@
----
-layout: default
----
-
-{{ content }}
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
deleted file mode 100644
index 5e71126..0000000
--- a/docs/_layouts/page.html
+++ /dev/null
@@ -1,5 +0,0 @@
----
-layout: default
----
-
-{{ content }}
diff --git a/docs/_layouts/post.html b/docs/_layouts/post.html
deleted file mode 100644
index 5e71126..0000000
--- a/docs/_layouts/post.html
+++ /dev/null
@@ -1,5 +0,0 @@
----
-layout: default
----
-
-{{ content }}
diff --git a/docs/_layouts/table_wrappers.html b/docs/_layouts/table_wrappers.html
deleted file mode 100644
index 3f8f226..0000000
--- a/docs/_layouts/table_wrappers.html
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: vendor/compress
----
-
-{% assign content_ = content | replace: '', '
' %} -{{ content_ }} diff --git a/docs/_layouts/vendor/compress.html b/docs/_layouts/vendor/compress.html deleted file mode 100644 index bb34487..0000000 --- a/docs/_layouts/vendor/compress.html +++ /dev/null @@ -1,10 +0,0 @@ ---- -# Jekyll layout that compresses HTML -# v3.1.0 -# http://jch.penibelst.de/ -# © 2014–2015 Anatol Broder -# MIT License ---- - -{% capture _LINE_FEED %} -{% endcapture %}{% if site.compress_html.ignore.envs contains jekyll.environment or site.compress_html.ignore.envs == "all" %}{{ content }}{% else %}{% capture _content %}{{ content }}{% endcapture %}{% assign _profile = site.compress_html.profile %}{% if site.compress_html.endings == "all" %}{% assign _endings = "html head body li dt dd optgroup option colgroup caption thead tbody tfoot tr td th" | split: " " %}{% else %}{% assign _endings = site.compress_html.endings %}{% endif %}{% for _element in _endings %}{% capture _end %}{% endcapture %}{% assign _content = _content | remove: _end %}{% endfor %}{% if _profile and _endings %}{% assign _profile_endings = _content | size | plus: 1 %}{% endif %}{% for _element in site.compress_html.startings %}{% capture _start %}<{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _start %}{% endfor %}{% if _profile and site.compress_html.startings %}{% assign _profile_startings = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.comments == "all" %}{% assign _comments = "" | split: " " %}{% else %}{% assign _comments = site.compress_html.comments %}{% endif %}{% if _comments.size == 2 %}{% capture _comment_befores %}.{{ _content }}{% endcapture %}{% assign _comment_befores = _comment_befores | split: _comments.first %}{% for _comment_before in _comment_befores %}{% if forloop.first %}{% continue %}{% endif %}{% capture _comment_outside %}{% if _carry %}{{ _comments.first }}{% endif %}{{ _comment_before }}{% endcapture %}{% capture _comment %}{% unless _carry %}{{ _comments.first }}{% endunless %}{{ _comment_outside | split: _comments.last | first }}{% if _comment_outside contains _comments.last %}{{ _comments.last }}{% assign _carry = false %}{% else %}{% assign _carry = true %}{% endif %}{% endcapture %}{% assign _content = _content | remove_first: _comment %}{% endfor %}{% if _profile %}{% assign _profile_comments = _content | size | plus: 1 %}{% endif %}{% endif %}{% assign _pre_befores = _content | split: "" %}{% assign _pres_after = "" %}{% if _pres.size != 0 %}{% if site.compress_html.blanklines %}{% assign _lines = _pres.last | split: _LINE_FEED %}{% capture _pres_after %}{% for _line in _lines %}{% assign _trimmed = _line | split: " " | join: " " %}{% if _trimmed != empty or forloop.last %}{% unless forloop.first %}{{ _LINE_FEED }}{% endunless %}{{ _line }}{% endif %}{% endfor %}{% endcapture %}{% else %}{% assign _pres_after = _pres.last | split: " " | join: " " %}{% endif %}{% endif %}{% capture _content %}{{ _content }}{% if _pre_before contains "" %}{% endif %}{% unless _pre_before contains "" and _pres.size == 1 %}{{ _pres_after }}{% endunless %}{% endcapture %}{% endfor %}{% if _profile %}{% assign _profile_collapse = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.clippings == "all" %}{% assign _clippings = "html head title base link meta style body article section nav aside h1 h2 h3 h4 h5 h6 hgroup header footer address p hr blockquote ol ul li dl dt dd figure figcaption main div table caption colgroup col tbody thead tfoot tr td th" | split: " " %}{% else %}{% assign _clippings = site.compress_html.clippings %}{% endif %}{% for _element in _clippings %}{% assign _edges = " ;; ;" | replace: "e", _element | split: ";" %}{% assign _content = _content | replace: _edges[0], _edges[1] | replace: _edges[2], _edges[3] | replace: _edges[4], _edges[5] %}{% endfor %}{% if _profile and _clippings %}{% assign _profile_clippings = _content | size | plus: 1 %}{% endif %}{{ _content }}{% if _profile %}
Step Bytes
raw {{ content | size }}{% if _profile_endings %}
endings {{ _profile_endings }}{% endif %}{% if _profile_startings %}
startings {{ _profile_startings }}{% endif %}{% if _profile_comments %}
comments {{ _profile_comments }}{% endif %}{% if _profile_collapse %}
collapse {{ _profile_collapse }}{% endif %}{% if _profile_clippings %}
clippings {{ _profile_clippings }}{% endif %}
{% endif %}{% endif %} diff --git a/docs/_sass/base.scss b/docs/_sass/base.scss deleted file mode 100644 index c3b6698..0000000 --- a/docs/_sass/base.scss +++ /dev/null @@ -1,108 +0,0 @@ -// -// Base element style overrides -// -// stylelint-disable selector-no-type, selector-max-type - -* { - box-sizing: border-box; -} - -::selection { - color: $white; - background: $link-color; -} - -html { - @include fs-4; - scroll-behavior: smooth; -} - -body { - font-family: $body-font-family; - font-size: inherit; - line-height: $body-line-height; - color: $body-text-color; - background-color: $body-background-color; -} - -ol, -ul, -dl, -pre, -address, -blockquote, -table, -div, -hr, -form, -fieldset, -noscript .table-wrapper { - margin-top: 0; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - margin-top: 0; - margin-bottom: 1em; - font-weight: 500; - line-height: $body-heading-line-height; - color: $body-heading-color; -} - -p { - margin-top: 1em; - margin-bottom: 1em; -} - -a { - color: $link-color; - text-decoration: none; -} - -a:not([class]) { - text-decoration: none; - background-image: linear-gradient($border-color 0%, $border-color 100%); - background-repeat: repeat-x; - background-position: 0 100%; - background-size: 1px 1px; - - &:hover { - background-image: linear-gradient( - rgba($link-color, 0.45) 0%, - rgba($link-color, 0.45) 100% - ); - background-size: 1px 1px; - } -} - -code { - font-family: $mono-font-family; - font-size: 0.75em; - line-height: $body-line-height; -} - -figure, -pre { - margin: 0; -} - -li { - margin: 0.25em 0; -} - -img { - max-width: 100%; - height: auto; -} - -hr { - height: 1px; - padding: 0; - margin: $sp-6 0; - background-color: $border-color; - border: 0; -} diff --git a/docs/_sass/buttons.scss b/docs/_sass/buttons.scss deleted file mode 100644 index 57660e0..0000000 --- a/docs/_sass/buttons.scss +++ /dev/null @@ -1,118 +0,0 @@ -// -// Buttons and things that look like buttons -// -// stylelint-disable color-named - -.btn { - display: inline-block; - box-sizing: border-box; - padding-top: 0.3em; - padding-right: 1em; - padding-bottom: 0.3em; - padding-left: 1em; - margin: 0; - font-family: inherit; - font-size: inherit; - font-weight: 500; - line-height: 1.5; - color: $link-color; - text-decoration: none; - vertical-align: baseline; - cursor: pointer; - background-color: $base-button-color; - border-width: 0; - border-radius: $border-radius; - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); - appearance: none; - - &:focus { - text-decoration: none; - outline: none; - box-shadow: 0 0 0 3px rgba(blue, 0.25); - } - - &:focus:hover, - &.selected:focus { - box-shadow: 0 0 0 3px rgba(blue, 0.25); - } - - &:hover, - &.zeroclipboard-is-hover { - color: darken($link-color, 2%); - } - - &:hover, - &:active, - &.zeroclipboard-is-hover, - &.zeroclipboard-is-active { - text-decoration: none; - background-color: darken($base-button-color, 1%); - } - - &:active, - &.selected, - &.zeroclipboard-is-active { - background-color: darken($base-button-color, 3%); - background-image: none; - box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15); - } - - &.selected:hover { - background-color: darken(#dcdcdc, 5%); - } - - &:disabled, - &.disabled { - &, - &:hover { - color: rgba(102, 102, 102, 0.5); - cursor: default; - background-color: rgba(229, 229, 229, 0.5); - background-image: none; - box-shadow: none; - } - } -} - -.btn-outline { - color: $link-color; - background: transparent; - box-shadow: inset 0 0 0 2px $grey-lt-300; - - &:hover, - &:active, - &.zeroclipboard-is-hover, - &.zeroclipboard-is-active { - color: darken($link-color, 4%); - text-decoration: none; - background-color: transparent; - box-shadow: inset 0 0 0 3px $grey-lt-300; - } - - &:focus { - text-decoration: none; - outline: none; - box-shadow: inset 0 0 0 2px $grey-dk-100, 0 0 0 3px rgba(blue, 0.25); - } - - &:focus:hover, - &.selected:focus { - box-shadow: inset 0 0 0 2px $grey-dk-100; - } -} - -.btn-primary { - @include btn-color($white, $btn-primary-color); -} - -.btn-purple { - @include btn-color($white, $purple-100); -} - -.btn-blue { - @include btn-color($white, $blue-000); -} - -.btn-green { - @include btn-color($white, $green-100); -} diff --git a/docs/_sass/code.scss b/docs/_sass/code.scss deleted file mode 100644 index f038912..0000000 --- a/docs/_sass/code.scss +++ /dev/null @@ -1,340 +0,0 @@ -// -// Code and syntax highlighting -// -// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type - -code { - padding: 0.2em 0.15em; - font-weight: 400; - background-color: $code-background-color; - border: $border $border-color; - border-radius: $border-radius; -} - -// Avoid appearance of dark border around visited code links in Safari -a:visited code { - border-color: $border-color; -} - -// Content structure for highlighted code blocks using fences or Liquid -// -// ```[LANG]...```, no kramdown line_numbers: -// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code -// -// ```[LANG]...```, kramdown line_numbers = true: -// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code -// > div.table-wrapper > table.rouge-table > tbody > tr -// > td.rouge-gutter.gl > pre.lineno -// | td.rouge-code > pre -// -// {% highlight LANG %}...{% endhighlight %}: -// figure.highlight > pre > code.language-LANG -// -// {% highlight LANG linenos %}...{% endhighlight %}: -// figure.highlight > pre > code.language-LANG -// > div.table-wrapper > table.rouge-table > tbody > tr -// > td.gutter.gl > pre.lineno -// | td.code > pre -// -// fix_linenos removes the outermost pre when it encloses table.rouge-table -// -// See docs/index-test.md for some tests. -// -// No kramdown line_numbers: fences and Liquid highlighting look the same. -// Kramdown line_numbers = true: fences have a wider gutter than with Liquid? - -// ```[LANG]...``` -div.highlighter-rouge { - padding: $sp-3; - margin-top: 0; - margin-bottom: $sp-3; - overflow-x: auto; - background-color: $code-background-color; - border-radius: $border-radius; - box-shadow: none; - -webkit-overflow-scrolling: touch; - - div.highlight, - pre.highlight, - code { - padding: 0; - margin: 0; - border: 0; - } -} - -// {% highlight LANG %}...{% endhighlight %}, -// {% highlight LANG linenos %}...{% endhighlight %}: -figure.highlight { - padding: $sp-3; - margin-top: 0; - margin-bottom: $sp-3; - background-color: $code-background-color; - border-radius: $border-radius; - box-shadow: none; - -webkit-overflow-scrolling: touch; - - pre, - code { - padding: 0; - margin: 0; - border: 0; - } -} - -// ```[LANG]...```, kramdown line_numbers = true, -// {% highlight LANG linenos %}...{% endhighlight %}: -.highlight .table-wrapper { - padding: 0; - margin: 0; - border: 0; - box-shadow: none; - - td, - pre { - @include fs-2; - min-width: 0; - padding: 0; - background-color: $code-background-color; - border: 0; - } - - td.gl { - padding-right: $sp-3; - } - - pre { - margin: 0; - line-height: 2; - } -} - -.highlight .c { - color: #586e75; -} // comment // -.highlight .err { - color: #93a1a1; -} // error // -.highlight .g { - color: #93a1a1; -} // generic // -.highlight .k { - color: #859900; -} // keyword // -.highlight .l { - color: #93a1a1; -} // literal // -.highlight .n { - color: #93a1a1; -} // name // -.highlight .o { - color: #859900; -} // operator // -.highlight .x { - color: #cb4b16; -} // other // -.highlight .p { - color: #93a1a1; -} // punctuation // -.highlight .cm { - color: #586e75; -} // comment.multiline // -.highlight .cp { - color: #859900; -} // comment.preproc // -.highlight .c1 { - color: #586e75; -} // comment.single // -.highlight .cs { - color: #859900; -} // comment.special // -.highlight .gd { - color: #2aa198; -} // generic.deleted // -.highlight .ge { - font-style: italic; - color: #93a1a1; -} // generic.emph // -.highlight .gr { - color: #dc322f; -} // generic.error // -.highlight .gh { - color: #cb4b16; -} // generic.heading // -.highlight .gi { - color: #859900; -} // generic.inserted // -.highlight .go { - color: #93a1a1; -} // generic.output // -.highlight .gp { - color: #93a1a1; -} // generic.prompt // -.highlight .gs { - font-weight: bold; - color: #93a1a1; -} // generic.strong // -.highlight .gu { - color: #cb4b16; -} // generic.subheading // -.highlight .gt { - color: #93a1a1; -} // generic.traceback // -.highlight .kc { - color: #cb4b16; -} // keyword.constant // -.highlight .kd { - color: #268bd2; -} // keyword.declaration // -.highlight .kn { - color: #859900; -} // keyword.namespace // -.highlight .kp { - color: #859900; -} // keyword.pseudo // -.highlight .kr { - color: #268bd2; -} // keyword.reserved // -.highlight .kt { - color: #dc322f; -} // keyword.type // -.highlight .ld { - color: #93a1a1; -} // literal.date // -.highlight .m { - color: #2aa198; -} // literal.number // -.highlight .s { - color: #2aa198; -} // literal.string // -.highlight .na { - color: #555; -} // name.attribute // -.highlight .nb { - color: #b58900; -} // name.builtin // -.highlight .nc { - color: #268bd2; -} // name.class // -.highlight .no { - color: #cb4b16; -} // name.constant // -.highlight .nd { - color: #268bd2; -} // name.decorator // -.highlight .ni { - color: #cb4b16; -} // name.entity // -.highlight .ne { - color: #cb4b16; -} // name.exception // -.highlight .nf { - color: #268bd2; -} // name.function // -.highlight .nl { - color: #555; -} // name.label // -.highlight .nn { - color: #93a1a1; -} // name.namespace // -.highlight .nx { - color: #555; -} // name.other // -.highlight .py { - color: #93a1a1; -} // name.property // -.highlight .nt { - color: #268bd2; -} // name.tag // -.highlight .nv { - color: #268bd2; -} // name.variable // -.highlight .ow { - color: #859900; -} // operator.word // -.highlight .w { - color: #93a1a1; -} // text.whitespace // -.highlight .mf { - color: #2aa198; -} // literal.number.float // -.highlight .mh { - color: #2aa198; -} // literal.number.hex // -.highlight .mi { - color: #2aa198; -} // literal.number.integer // -.highlight .mo { - color: #2aa198; -} // literal.number.oct // -.highlight .sb { - color: #586e75; -} // literal.string.backtick // -.highlight .sc { - color: #2aa198; -} // literal.string.char // -.highlight .sd { - color: #93a1a1; -} // literal.string.doc // -.highlight .s2 { - color: #2aa198; -} // literal.string.double // -.highlight .se { - color: #cb4b16; -} // literal.string.escape // -.highlight .sh { - color: #93a1a1; -} // literal.string.heredoc // -.highlight .si { - color: #2aa198; -} // literal.string.interpol // -.highlight .sx { - color: #2aa198; -} // literal.string.other // -.highlight .sr { - color: #dc322f; -} // literal.string.regex // -.highlight .s1 { - color: #2aa198; -} // literal.string.single // -.highlight .ss { - color: #2aa198; -} // literal.string.symbol // -.highlight .bp { - color: #268bd2; -} // name.builtin.pseudo // -.highlight .vc { - color: #268bd2; -} // name.variable.class // -.highlight .vg { - color: #268bd2; -} // name.variable.global // -.highlight .vi { - color: #268bd2; -} // name.variable.instance // -.highlight .il { - color: #2aa198; -} // literal.number.integer.long // - -// -// Code examples (rendered) -// - -.code-example { - padding: $sp-3; - margin-bottom: $sp-3; - overflow: auto; - border: 1px solid $border-color; - border-radius: $border-radius; - - + .highlighter-rouge, - + figure.highlight { - position: relative; - margin-top: -$sp-4; - border-right: 1px solid $border-color; - border-bottom: 1px solid $border-color; - border-left: 1px solid $border-color; - border-top-left-radius: 0; - border-top-right-radius: 0; - } -} diff --git a/docs/_sass/color_schemes/dark.scss b/docs/_sass/color_schemes/dark.scss deleted file mode 100644 index a25f449..0000000 --- a/docs/_sass/color_schemes/dark.scss +++ /dev/null @@ -1,17 +0,0 @@ -$body-background-color: $grey-dk-300; -$sidebar-color: $grey-dk-300; -$border-color: $grey-dk-200; - -$body-text-color: $grey-lt-300; -$body-heading-color: $grey-lt-000; -$nav-child-link-color: $grey-dk-000; -$search-result-preview-color: $grey-dk-000; - -$link-color: $blue-000; -$btn-primary-color: $blue-200; -$base-button-color: $grey-dk-250; - -$code-background-color: $grey-dk-250; -$search-background-color: $grey-dk-250; -$table-background-color: $grey-dk-250; -$feedback-color: darken($sidebar-color, 3%); diff --git a/docs/_sass/color_schemes/light.scss b/docs/_sass/color_schemes/light.scss deleted file mode 100644 index e69de29..0000000 diff --git a/docs/_sass/content.scss b/docs/_sass/content.scss deleted file mode 100644 index a53271a..0000000 --- a/docs/_sass/content.scss +++ /dev/null @@ -1,231 +0,0 @@ -@charset "UTF-8"; - -// -// Styles for rendered markdown in the .main-content container -// -// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type - -.main-content { - line-height: $content-line-height; - - ol, - ul, - dl, - pre, - address, - blockquote, - .table-wrapper { - margin-top: 0.5em; - } - - a { - overflow: hidden; - text-overflow: ellipsis; - white-space: nowrap; - } - - ul, - ol { - padding-left: 1.5em; - } - - li { - .highlight { - margin-top: $sp-1; - } - } - - ol { - list-style-type: none; - counter-reset: step-counter; - - > li { - position: relative; - - &::before { - position: absolute; - top: 0.2em; - left: -1.6em; - color: $grey-dk-000; - content: counter(step-counter); - counter-increment: step-counter; - @include fs-3; - - @include mq(sm) { - top: 0.11em; - } - } - - ol { - counter-reset: sub-counter; - - li { - &::before { - content: counter(sub-counter, lower-alpha); - counter-increment: sub-counter; - } - } - } - } - } - - ul { - list-style: none; - - > li { - &::before { - position: absolute; - margin-left: -1.4em; - color: $grey-dk-000; - content: "•"; - } - } - } - - .task-list { - padding-left: 0; - } - - .task-list-item { - display: flex; - align-items: center; - - &::before { - content: ""; - } - } - - .task-list-item-checkbox { - margin-right: 0.6em; - } - - hr + * { - margin-top: 0; - } - - h1:first-of-type { - margin-top: 0.5em; - } - - dl { - display: grid; - grid-template: auto / 10em 1fr; - } - - dt, - dd { - margin: 0.25em 0; - } - - dt { - grid-column: 1; - font-weight: 500; - text-align: right; - &::after { - content: ":"; - } - } - - dd { - grid-column: 2; - margin-bottom: 0; - margin-left: 1em; - blockquote, - div, - dl, - dt, - h1, - h2, - h3, - h4, - h5, - h6, - li, - ol, - p, - pre, - table, - ul, - .table-wrapper { - &:first-child { - margin-top: 0; - } - } - } - - dd, - ol, - ul { - dl:first-child { - dt:first-child, - dd:nth-child(2) { - margin-top: 0; - } - } - } - - .anchor-heading { - position: absolute; - right: -$sp-4; - width: $sp-5; - height: 100%; - padding-right: $sp-1; - padding-left: $sp-1; - overflow: visible; - - @include mq(md) { - right: auto; - left: -$sp-5; - } - - svg { - display: inline-block; - width: 100%; - height: 100%; - color: $link-color; - visibility: hidden; - } - } - - .anchor-heading:hover, - h1:hover > .anchor-heading, - h2:hover > .anchor-heading, - h3:hover > .anchor-heading, - h4:hover > .anchor-heading, - h5:hover > .anchor-heading, - h6:hover > .anchor-heading { - svg { - visibility: visible; - } - } - - summary { - cursor: pointer; - } - - h1, - h2, - h3, - h4, - h5, - h6 { - position: relative; - margin-top: 1.5em; - margin-bottom: 0.25em; - - &:first-child { - margin-top: $sp-2; - } - - + table, - + .table-wrapper, - + .code-example, - + .highlighter-rouge { - margin-top: 1em; - } - - + p { - margin-top: 0; - } - } -} diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss deleted file mode 100644 index 3e964f2..0000000 --- a/docs/_sass/custom/custom.scss +++ /dev/null @@ -1,3 +0,0 @@ -td { - vertical-align: top; -} \ No newline at end of file diff --git a/docs/_sass/labels.scss b/docs/_sass/labels.scss deleted file mode 100644 index e08ae80..0000000 --- a/docs/_sass/labels.scss +++ /dev/null @@ -1,37 +0,0 @@ -// -// Labels (not the form kind) -// - -.label, -.label-blue { - display: inline-block; - padding-top: 0.16em; - padding-right: 0.56em; - padding-bottom: 0.16em; - padding-left: 0.56em; - margin-right: $sp-2; - margin-left: $sp-2; - color: $white; - text-transform: uppercase; - vertical-align: middle; - background-color: $blue-100; - @include fs-2; - border-radius: 12px; -} - -.label-green { - background-color: $green-200; -} - -.label-purple { - background-color: $purple-100; -} - -.label-red { - background-color: $red-200; -} - -.label-yellow { - color: $grey-dk-200; - background-color: $yellow-200; -} diff --git a/docs/_sass/layout.scss b/docs/_sass/layout.scss deleted file mode 100644 index 8559bb0..0000000 --- a/docs/_sass/layout.scss +++ /dev/null @@ -1,205 +0,0 @@ -// -// The basic two column layout -// - -.side-bar { - z-index: 0; - display: flex; - flex-wrap: wrap; - background-color: $sidebar-color; - - @include mq(md) { - flex-wrap: nowrap; - position: fixed; - width: $nav-width-md; - height: 100%; - flex-direction: column; - border-right: $border $border-color; - align-items: flex-end; - } - - @include mq(lg) { - width: calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width}); - min-width: $nav-width; - } -} - -.main { - @include mq(md) { - position: relative; - max-width: $content-width; - margin-left: $nav-width-md; - } - - @include mq(lg) { - margin-left: calc( - (100% - #{$nav-width + $content-width}) / 2 + #{$nav-width} - ); - } -} - -.main-content-wrap { - @include container; - padding-top: $gutter-spacing-sm; - padding-bottom: $gutter-spacing-sm; - - @include mq(md) { - padding-top: $gutter-spacing; - padding-bottom: $gutter-spacing; - } -} - -.main-header { - z-index: 0; - display: none; - background-color: $sidebar-color; - - @include mq(md) { - display: flex; - justify-content: space-between; - height: $header-height; - background-color: $body-background-color; - border-bottom: $border $border-color; - } - - &.nav-open { - display: block; - - @include mq(md) { - display: flex; - } - } -} - -.site-nav, -.site-header, -.site-footer { - width: 100%; - - @include mq(lg) { - width: $nav-width; - } -} - -.site-nav { - display: none; - - &.nav-open { - display: block; - } - - @include mq(md) { - display: block; - padding-top: $sp-8; - padding-bottom: $gutter-spacing-sm; - overflow-y: auto; - flex: 1 1 auto; - } -} - -.site-header { - display: flex; - min-height: $header-height; - align-items: center; - - @include mq(md) { - height: 1.5*$header-height; - max-height: 1.5*$header-height; - border-bottom: $border $border-color; - } -} - -.site-title { - @include container; - flex-grow: 1; - display: flex; - height: 100%; - align-items: center; - padding-top: $sp-3; - padding-bottom: $sp-3; - color: $body-heading-color; - @include fs-6; - - @include mq(md) { - padding-top: $sp-2; - padding-bottom: $sp-2; - } -} - -@if variable-exists(logo) { - .site-logo { - width: 100%; - height: 100%; - background-image: url($logo); - background-repeat: no-repeat; - background-position: left center; - background-size: contain; - } -} - -.site-button { - display: flex; - height: 100%; - padding: $gutter-spacing-sm; - align-items: center; -} - -@include mq(md) { - .site-header .site-button { - display: none; - } -} - -.site-title:hover { - background-image: linear-gradient( - -90deg, - rgba($feedback-color, 1) 0%, - rgba($feedback-color, 0.8) 80%, - rgba($feedback-color, 0) 100% - ); -} - -.site-button:hover { - background-image: linear-gradient( - -90deg, - rgba($feedback-color, 1) 0%, - rgba($feedback-color, 0.8) 100% - ); -} - -// stylelint-disable selector-max-type - -body { - position: relative; - padding-bottom: $sp-10; - overflow-y: scroll; - - @include mq(md) { - position: static; - padding-bottom: 0; - } -} - -// stylelint-enable selector-max-type - -.site-footer { - @include container; - position: absolute; - bottom: 0; - left: 0; - padding-top: $sp-4; - padding-bottom: $sp-4; - color: $grey-dk-000; - @include fs-2; - - @include mq(md) { - position: static; - justify-self: end; - } -} - -.icon { - width: $sp-5; - height: $sp-5; - color: $link-color; -} diff --git a/docs/_sass/modules.scss b/docs/_sass/modules.scss deleted file mode 100644 index d82591b..0000000 --- a/docs/_sass/modules.scss +++ /dev/null @@ -1,20 +0,0 @@ -// -// Import external dependencies -// -@import "./vendor/normalize.scss/normalize.scss"; - -// -// Modules -// -@import "./base"; -@import "./layout"; -@import "./content"; -@import "./navigation"; -@import "./typography"; -@import "./labels"; -@import "./buttons"; -@import "./search"; -@import "./tables"; -@import "./code"; -@import "./utilities/utilities"; -@import "./print"; diff --git a/docs/_sass/navigation.scss b/docs/_sass/navigation.scss deleted file mode 100644 index 521c15f..0000000 --- a/docs/_sass/navigation.scss +++ /dev/null @@ -1,219 +0,0 @@ -// -// Main nav, breadcrumb, etc... -// -// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity - -.nav-list { - padding: 0; - margin-top: 0; - margin-bottom: 0; - list-style: none; - - .nav-list-item { - @include fs-4; - position: relative; - margin: 0; - - @include mq(md) { - @include fs-3; - } - - .nav-list-link { - display: block; - min-height: $nav-list-item-height-sm; - padding-top: $sp-1; - padding-bottom: $sp-1; - line-height: #{$nav-list-item-height-sm - 2 * $sp-1}; - @if $nav-list-expander-right { - padding-right: $nav-list-item-height-sm; - padding-left: $gutter-spacing-sm; - } @else { - padding-right: $gutter-spacing-sm; - padding-left: $nav-list-item-height-sm; - } - - @include mq(md) { - min-height: $nav-list-item-height; - line-height: #{$nav-list-item-height - 2 * $sp-1}; - @if $nav-list-expander-right { - padding-right: $nav-list-item-height; - padding-left: $gutter-spacing; - } @else { - padding-right: $gutter-spacing; - padding-left: $nav-list-item-height; - } - } - - &.active { - font-weight: 600; - text-decoration: none; - } - - &:hover, - &.active { - background-image: linear-gradient( - -90deg, - rgba($feedback-color, 1) 0%, - rgba($feedback-color, 0.8) 80%, - rgba($feedback-color, 0) 100% - ); - } - } - - .nav-list-expander { - position: absolute; - @if $nav-list-expander-right { - right: 0; - } - width: $nav-list-item-height-sm; - height: $nav-list-item-height-sm; - padding-top: #{$nav-list-item-height-sm / 4}; - padding-right: #{$nav-list-item-height-sm / 4}; - padding-bottom: #{$nav-list-item-height-sm / 4}; - padding-left: #{$nav-list-item-height-sm / 4}; - color: $link-color; - - @include mq(md) { - width: $nav-list-item-height; - height: $nav-list-item-height; - padding-top: #{$nav-list-item-height / 4}; - padding-right: #{$nav-list-item-height / 4}; - padding-bottom: #{$nav-list-item-height / 4}; - padding-left: #{$nav-list-item-height / 4}; - } - - &:hover { - background-image: linear-gradient( - -90deg, - rgba($feedback-color, 1) 0%, - rgba($feedback-color, 0.8) 100% - ); - } - - @if $nav-list-expander-right { - svg { - transform: rotate(90deg); - } - } - } - - > .nav-list { - display: none; - padding-left: $sp-3; - list-style: none; - - .nav-list-item { - position: relative; - - .nav-list-link { - color: $nav-child-link-color; - } - - .nav-list-expander { - color: $nav-child-link-color; - } - } - } - - &.active { - > .nav-list-expander svg { - @if $nav-list-expander-right { - transform: rotate(-90deg); - } @else { - transform: rotate(90deg); - } - } - - > .nav-list { - display: block; - } - } - } -} - -.nav-category { - padding-top: $sp-2; - padding-right: $gutter-spacing-sm; - padding-bottom: $sp-2; - padding-left: $gutter-spacing-sm; - font-weight: 600; - text-align: end; - text-transform: uppercase; - border-bottom: $border $border-color; - @include fs-2; - - @include mq(md) { - padding-right: $gutter-spacing; - padding-left: $gutter-spacing; - margin-top: $gutter-spacing-sm; - text-align: start; - - &:first-child { - margin-top: 0; - } - } -} - -// Aux nav - -.aux-nav { - height: 100%; - overflow-x: auto; - @include fs-2; - - .aux-nav-list { - display: flex; - height: 100%; - padding: 0; - margin: 0; - list-style: none; - } - - .aux-nav-list-item { - display: inline-block; - height: 100%; - padding: 0; - margin: 0; - } - - @include mq(md) { - padding-right: $gutter-spacing-sm; - } -} - -// Breadcrumb nav - -.breadcrumb-nav { - @include mq(md) { - margin-top: -$sp-4; - } -} - -.breadcrumb-nav-list { - padding-left: 0; - margin-bottom: $sp-3; - list-style: none; -} - -.breadcrumb-nav-list-item { - display: table-cell; - @include fs-2; - - &::before { - display: none; - } - - &::after { - display: inline-block; - margin-right: $sp-2; - margin-left: $sp-2; - color: $grey-dk-000; - content: "/"; - } - - &:last-child { - &::after { - content: ""; - } - } -} diff --git a/docs/_sass/print.scss b/docs/_sass/print.scss deleted file mode 100644 index 6e6de37..0000000 --- a/docs/_sass/print.scss +++ /dev/null @@ -1,40 +0,0 @@ -// stylelint-disable selector-max-specificity, selector-max-id, selector-max-type, selector-no-qualifying-type, primer/no-override, - -@media print { - .site-footer, - .site-button, - #edit-this-page, - #back-to-top, - .site-nav, - .main-header { - display: none !important; - } - - .side-bar { - width: 100%; - height: auto; - border-right: 0 !important; - } - - .site-header { - border-bottom: 1px solid $border-color; - } - - .site-title { - font-size: $root-font-size !important; - font-weight: 700 !important; - } - - .text-small { - font-size: 8pt !important; - } - - pre.highlight { - border: 1px solid $border-color; - } - - .main { - max-width: none; - margin-left: 0; - } -} diff --git a/docs/_sass/search.scss b/docs/_sass/search.scss deleted file mode 100644 index 4290210..0000000 --- a/docs/_sass/search.scss +++ /dev/null @@ -1,323 +0,0 @@ -// -// Search input and autocomplete -// - -.search { - position: relative; - z-index: 2; - flex-grow: 1; - height: $sp-10; - padding: $sp-2; - transition: padding linear #{$transition-duration / 2}; - - @include mq(md) { - position: relative !important; - width: auto !important; - height: 100% !important; - padding: 0; - transition: none; - } -} - -.search-input-wrap { - position: relative; - z-index: 1; - height: $sp-8; - overflow: hidden; - border-radius: $border-radius; - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); - transition: height linear #{$transition-duration / 2}; - - @include mq(md) { - position: absolute; - width: 100%; - max-width: $search-results-width; - height: 100% !important; - border-radius: 0; - box-shadow: none; - transition: width ease $transition-duration; - } -} - -.search-input { - position: absolute; - width: 100%; - height: 100%; - padding-top: $sp-2; - padding-right: $gutter-spacing-sm; - padding-bottom: $sp-2; - padding-left: #{$gutter-spacing-sm + $sp-5}; - font-size: 16px; - background-color: $search-background-color; - border-top: 0; - border-right: 0; - border-bottom: 0; - border-left: 0; - border-radius: 0; - - @include mq(md) { - padding-top: $gutter-spacing-sm; - padding-bottom: $gutter-spacing-sm; - padding-left: #{$gutter-spacing + $sp-5}; - font-size: 14px; - background-color: $body-background-color; - transition: padding-left linear #{$transition-duration / 2}; - } - - &:focus { - outline: 0; - - + .search-label .search-icon { - color: $link-color; - } - } -} - -.search-label { - position: absolute; - display: flex; - height: 100%; - padding-left: $gutter-spacing-sm; - - @include mq(md) { - padding-left: $gutter-spacing; - transition: padding-left linear #{$transition-duration / 2}; - } - - .search-icon { - width: #{$sp-4 * 1.2}; - height: #{$sp-4 * 1.2}; - align-self: center; - color: $grey-dk-000; - } -} - -.search-results { - position: absolute; - left: 0; - display: none; - width: 100%; - max-height: calc(100% - #{$sp-10}); - overflow-y: auto; - background-color: $search-background-color; - border-bottom-right-radius: $border-radius; - border-bottom-left-radius: $border-radius; - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); - - @include mq(md) { - top: 100%; - width: $search-results-width; - max-height: calc(100vh - 200%) !important; - } -} - -.search-results-list { - padding-left: 0; - margin-bottom: $sp-1; - list-style: none; - @include fs-4; - - @include mq(md) { - @include fs-3; - } -} - -.search-results-list-item { - padding: 0; - margin: 0; -} - -.search-result { - display: block; - padding-top: $sp-1; - padding-right: $sp-3; - padding-bottom: $sp-1; - padding-left: $sp-3; - - &:hover, - &.active { - background-color: $feedback-color; - } -} - -.search-result-title { - display: block; - padding-top: $sp-2; - padding-bottom: $sp-2; - - @include mq(sm) { - display: inline-block; - width: 40%; - padding-right: $sp-2; - vertical-align: top; - } -} - -.search-result-doc { - display: flex; - align-items: center; - word-wrap: break-word; - - &.search-result-doc-parent { - opacity: 0.5; - @include fs-3; - - @include mq(md) { - @include fs-2; - } - } - - .search-result-icon { - width: $sp-4; - height: $sp-4; - margin-right: $sp-2; - color: $link-color; - flex-shrink: 0; - } - - .search-result-doc-title { - overflow: auto; - } -} - -.search-result-section { - margin-left: #{$sp-4 + $sp-2}; - word-wrap: break-word; -} - -.search-result-rel-url { - display: block; - margin-left: #{$sp-4 + $sp-2}; - overflow: hidden; - color: $search-result-preview-color; - text-overflow: ellipsis; - white-space: nowrap; - @include fs-1; -} - -.search-result-previews { - display: block; - padding-top: $sp-2; - padding-bottom: $sp-2; - padding-left: $sp-4; - margin-left: $sp-2; - color: $search-result-preview-color; - word-wrap: break-word; - border-left: $border; - border-left-color: $border-color; - @include fs-2; - - @include mq(sm) { - display: inline-block; - width: 60%; - padding-left: $sp-2; - margin-left: 0; - vertical-align: top; - } -} - -.search-result-preview + .search-result-preview { - margin-top: $sp-1; -} - -.search-result-highlight { - font-weight: bold; -} - -.search-no-result { - padding-top: $sp-2; - padding-right: $sp-3; - padding-bottom: $sp-2; - padding-left: $sp-3; - @include fs-3; -} - -.search-button { - position: fixed; - right: $sp-4; - bottom: $sp-4; - display: flex; - width: $sp-9; - height: $sp-9; - background-color: $search-background-color; - border: 1px solid rgba($link-color, 0.3); - border-radius: #{$sp-9 / 2}; - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); - align-items: center; - justify-content: center; -} - -.search-overlay { - position: fixed; - top: 0; - left: 0; - z-index: 1; - width: 0; - height: 0; - background-color: rgba(0, 0, 0, 0.3); - opacity: 0; - transition: opacity ease $transition-duration, width 0s $transition-duration, - height 0s $transition-duration; -} - -.search-active { - .search { - position: fixed; - top: 0; - left: 0; - width: 100%; - height: 100%; - padding: 0; - } - - .search-input-wrap { - height: $sp-10; - border-radius: 0; - - @include mq(md) { - width: $search-results-width; - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); - } - } - - .search-input { - background-color: $search-background-color; - - @include mq(md) { - padding-left: 2.3rem; - } - } - - .search-label { - @include mq(md) { - padding-left: 0.6rem; - } - } - - .search-results { - display: block; - } - - .search-overlay { - width: 100%; - height: 100%; - opacity: 1; - transition: opacity ease $transition-duration, width 0s, height 0s; - } - - @include mq(md) { - .main { - position: fixed; - right: 0; - left: 0; - } - } - - .main-header { - padding-top: $sp-10; - - @include mq(md) { - padding-top: 0; - } - } -} diff --git a/docs/_sass/support/_functions.scss b/docs/_sass/support/_functions.scss deleted file mode 100644 index 6772f4e..0000000 --- a/docs/_sass/support/_functions.scss +++ /dev/null @@ -1,9 +0,0 @@ -@function rem($size, $unit: "") { - $remSize: $size / $root-font-size; - - @if ($unit == false) { - @return #{$remSize}; - } @else { - @return #{$remSize}rem; - } -} diff --git a/docs/_sass/support/_variables.scss b/docs/_sass/support/_variables.scss deleted file mode 100644 index 3ab3f05..0000000 --- a/docs/_sass/support/_variables.scss +++ /dev/null @@ -1,153 +0,0 @@ -// -// Typography -// - -$body-font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", - Roboto, "Helvetica Neue", Arial, sans-serif !default; -$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default; -$root-font-size: 16px !default; // Base font-size for rems -$body-line-height: 1.4 !default; -$content-line-height: 1.6 !default; -$body-heading-line-height: 1.25 !default; - -// -// Font size -// `-sm` suffix is the size at the small (and above) media query -// - -$font-size-1: 9px !default; -$font-size-1-sm: 10px !default; -$font-size-2: 11px !default; //h4 - uppercased!, h6 not uppercased, text-small -$font-size-3: 12px !default; //h5 -$font-size-4: 14px !default; -$font-size-5: 16px !default; //h3 -$font-size-6: 18px !default; //h2 -$font-size-7: 24px !default; -$font-size-8: 32px !default; //h1 -$font-size-9: 36px !default; -$font-size-10: 42px !default; -$font-size-10-sm: 48px !default; - -// -// Colors -// - -$white: #fff !default; - -$grey-dk-000: #959396 !default; -$grey-dk-100: #5c5962 !default; -$grey-dk-200: #44434d !default; -$grey-dk-250: #302d36 !default; -$grey-dk-300: #27262b !default; - -$grey-lt-000: #f5f6fa !default; -$grey-lt-100: #eeebee !default; -$grey-lt-200: #ecebed !default; -$grey-lt-300: #e6e1e8 !default; - -$purple-000: #7253ed !default; -$purple-100: #5e41d0 !default; -$purple-200: #4e26af !default; -$purple-300: #381885 !default; - -$blue-000: #2c84fa !default; -$blue-100: #2869e6 !default; -$blue-200: #264caf !default; -$blue-300: #183385 !default; - -$green-000: #41d693 !default; -$green-100: #11b584 !default; -$green-200: #009c7b !default; -$green-300: #026e57 !default; - -$yellow-000: #ffeb82 !default; -$yellow-100: #fadf50 !default; -$yellow-200: #f7d12e !default; -$yellow-300: #e7af06 !default; - -$red-000: #f77e7e !default; -$red-100: #f96e65 !default; -$red-200: #e94c4c !default; -$red-300: #dd2e2e !default; - -$body-background-color: $white !default; -$sidebar-color: $grey-lt-000 !default; -$search-background-color: $white !default; -$table-background-color: $white !default; -$code-background-color: $grey-lt-000 !default; -$feedback-color: darken($sidebar-color, 3%) !default; - -$body-text-color: $grey-dk-100 !default; -$body-heading-color: $grey-dk-300 !default; -$search-result-preview-color: $grey-dk-000 !default; -$nav-child-link-color: $grey-dk-100 !default; -$link-color: $purple-000 !default; -$btn-primary-color: $purple-100 !default; -$base-button-color: #f7f7f7 !default; - -// -// Spacing -// - -$spacing-unit: 1rem; // 1rem == 16px - -$spacers: ( - sp-0: 0, - sp-1: $spacing-unit * 0.25, - sp-2: $spacing-unit * 0.5, - sp-3: $spacing-unit * 0.75, - sp-4: $spacing-unit, - sp-5: $spacing-unit * 1.5, - sp-6: $spacing-unit * 2, - sp-7: $spacing-unit * 2.5, - sp-8: $spacing-unit * 3, - sp-9: $spacing-unit * 3.5, - sp-10: $spacing-unit * 4, -) !default; - -$sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px -$sp-2: map-get($spacers, sp-2) !default; // 0.5 rem == 8px -$sp-3: map-get($spacers, sp-3) !default; // 0.75 rem == 12px -$sp-4: map-get($spacers, sp-4) !default; // 1 rem == 16px -$sp-5: map-get($spacers, sp-5) !default; // 1.5 rem == 24px -$sp-6: map-get($spacers, sp-6) !default; // 2 rem == 32px -$sp-7: map-get($spacers, sp-7) !default; // 2.5 rem == 40px -$sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px -$sp-9: map-get($spacers, sp-9) !default; // 3.5 rem == 56px -$sp-10: map-get($spacers, sp-10) !default; // 4 rem == 64px - -// -// Borders -// - -$border: 1px solid !default; -$border-radius: 4px !default; -$border-color: $grey-lt-100 !default; - -// -// Grid system -// - -$gutter-spacing: $sp-6 !default; -$gutter-spacing-sm: $sp-4 !default; -$nav-width: 264px !default; -$nav-width-md: 248px !default; -$nav-list-item-height: $sp-6 !default; -$nav-list-item-height-sm: $sp-8 !default; -$nav-list-expander-right: true; -$content-width: 800px !default; -$header-height: 60px !default; -$search-results-width: $content-width - $nav-width !default; -$transition-duration: 400ms; - -// -// Media queries in pixels -// - -$media-queries: ( - xs: 320px, - sm: 500px, - md: $content-width, - lg: $content-width + $nav-width, - xl: 1400px, -) !default; diff --git a/docs/_sass/support/mixins/_buttons.scss b/docs/_sass/support/mixins/_buttons.scss deleted file mode 100644 index e3e6c4f..0000000 --- a/docs/_sass/support/mixins/_buttons.scss +++ /dev/null @@ -1,27 +0,0 @@ -// Colored button - -@mixin btn-color($fg, $bg) { - color: $fg; - background-color: darken($bg, 2%); - background-image: linear-gradient(lighten($bg, 5%), darken($bg, 2%)); - box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25), 0 4px 10px rgba(0, 0, 0, 0.12); - - &:hover, - &.zeroclipboard-is-hover { - color: $fg; - background-color: darken($bg, 4%); - background-image: linear-gradient((lighten($bg, 2%), darken($bg, 4%))); - } - - &:active, - &.selected, - &.zeroclipboard-is-active { - background-color: darken($bg, 5%); - background-image: none; - box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15); - } - - &.selected:hover { - background-color: darken($bg, 10%); - } -} diff --git a/docs/_sass/support/mixins/_layout.scss b/docs/_sass/support/mixins/_layout.scss deleted file mode 100644 index 27ad6c7..0000000 --- a/docs/_sass/support/mixins/_layout.scss +++ /dev/null @@ -1,34 +0,0 @@ -// Media query - -// Media query mixin -// Usage: -// @include mq(md) { -// ..medium and up styles -// } -@mixin mq($name) { - // Retrieves the value from the key - $value: map-get($media-queries, $name); - - // If the key exists in the map - @if $value != null { - // Prints a media query based on the value - @media (min-width: rem($value)) { - @content; - } - } @else { - @warn "No value could be retrieved from `#{$media-query}`. " - + "Please make sure it is defined in `$media-queries` map."; - } -} - -// Responsive container - -@mixin container { - padding-right: $gutter-spacing-sm; - padding-left: $gutter-spacing-sm; - - @include mq(md) { - padding-right: $gutter-spacing; - padding-left: $gutter-spacing; - } -} diff --git a/docs/_sass/support/mixins/_typography.scss b/docs/_sass/support/mixins/_typography.scss deleted file mode 100644 index 5207fcd..0000000 --- a/docs/_sass/support/mixins/_typography.scss +++ /dev/null @@ -1,84 +0,0 @@ -@mixin fs-1 { - font-size: $font-size-1 !important; - - @include mq(sm) { - font-size: $font-size-1-sm !important; - } -} - -@mixin fs-2 { - font-size: $font-size-2 !important; - - @include mq(sm) { - font-size: $font-size-3 !important; - } -} - -@mixin fs-3 { - font-size: $font-size-3 !important; - - @include mq(sm) { - font-size: $font-size-4 !important; - } -} - -@mixin fs-4 { - font-size: $font-size-4 !important; - - @include mq(sm) { - font-size: $font-size-5 !important; - } -} - -@mixin fs-5 { - font-size: $font-size-5 !important; - - @include mq(sm) { - font-size: $font-size-6 !important; - } -} - -@mixin fs-6 { - font-size: $font-size-6 !important; - - @include mq(sm) { - font-size: $font-size-7 !important; - line-height: $body-heading-line-height; - } -} - -@mixin fs-7 { - font-size: $font-size-7 !important; - line-height: $body-heading-line-height; - - @include mq(sm) { - font-size: $font-size-8 !important; - } -} - -@mixin fs-8 { - font-size: $font-size-8 !important; - line-height: $body-heading-line-height; - - @include mq(sm) { - font-size: $font-size-9 !important; - } -} - -@mixin fs-9 { - font-size: $font-size-9 !important; - line-height: $body-heading-line-height; - - @include mq(sm) { - font-size: $font-size-10 !important; - } -} - -@mixin fs-10 { - font-size: $font-size-10 !important; - line-height: $body-heading-line-height; - - @include mq(sm) { - font-size: $font-size-10-sm !important; - } -} diff --git a/docs/_sass/support/mixins/mixins.scss b/docs/_sass/support/mixins/mixins.scss deleted file mode 100644 index 0506fbf..0000000 --- a/docs/_sass/support/mixins/mixins.scss +++ /dev/null @@ -1,3 +0,0 @@ -@import "./layout"; -@import "./buttons"; -@import "./typography"; diff --git a/docs/_sass/support/support.scss b/docs/_sass/support/support.scss deleted file mode 100644 index 8131a32..0000000 --- a/docs/_sass/support/support.scss +++ /dev/null @@ -1,3 +0,0 @@ -@import "./variables"; -@import "./functions"; -@import "./mixins/mixins"; diff --git a/docs/_sass/tables.scss b/docs/_sass/tables.scss deleted file mode 100644 index 99b8d5e..0000000 --- a/docs/_sass/tables.scss +++ /dev/null @@ -1,59 +0,0 @@ -// -// Tables -// -// stylelint-disable max-nesting-depth, selector-no-type, selector-max-type - -.table-wrapper { - display: block; - width: 100%; - max-width: 100%; - margin-bottom: $sp-5; - overflow-x: auto; - border-radius: $border-radius; - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); -} - -table { - display: table; - min-width: 100%; - border-collapse: separate; -} - -th, -td { - @include fs-3; - min-width: 120px; - padding-top: $sp-2; - padding-right: $sp-3; - padding-bottom: $sp-2; - padding-left: $sp-3; - background-color: $table-background-color; - border-bottom: $border rgba($border-color, 0.5); - border-left: $border $border-color; - vertical-align: top; - - &:first-of-type { - border-left: 0; - } -} - -tbody { - tr { - &:last-of-type { - th, - td { - border-bottom: 0; - } - - td { - padding-bottom: $sp-3; - } - } - } -} - -thead { - th { - border-bottom: $border $border-color; - } -} diff --git a/docs/_sass/typography.scss b/docs/_sass/typography.scss deleted file mode 100644 index cadee36..0000000 --- a/docs/_sass/typography.scss +++ /dev/null @@ -1,64 +0,0 @@ -// -// Typography -// -// stylelint-disable primer/selector-no-utility, primer/no-override, selector-no-type, selector-max-type - -h1, -.text-alpha { - @include fs-8; - font-weight: 300; -} - -h2, -.text-beta { - @include fs-6; -} - -h3, -.text-gamma { - @include fs-5; -} - -h4, -.text-delta { - @include fs-2; - font-weight: 400; - text-transform: uppercase; - letter-spacing: 0.1em; -} - -h4 code { - text-transform: none; -} - -h5, -.text-epsilon { - @include fs-3; - color: $grey-dk-200; -} - -h6, -.text-zeta { - @include fs-2; - color: $grey-dk-200; -} - -.text-small { - @include fs-2; -} - -.text-mono { - font-family: $mono-font-family !important; -} - -.text-left { - text-align: left !important; -} - -.text-center { - text-align: center !important; -} - -.text-right { - text-align: right !important; -} diff --git a/docs/_sass/utilities/_colors.scss b/docs/_sass/utilities/_colors.scss deleted file mode 100644 index f3607ab..0000000 --- a/docs/_sass/utilities/_colors.scss +++ /dev/null @@ -1,239 +0,0 @@ -// -// Utility classes for colors -// - -// Text colors - -.text-grey-dk-000 { - color: $grey-dk-000 !important; -} - -.text-grey-dk-100 { - color: $grey-dk-100 !important; -} - -.text-grey-dk-200 { - color: $grey-dk-200 !important; -} - -.text-grey-dk-250 { - color: $grey-dk-250 !important; -} - -.text-grey-dk-300 { - color: $grey-dk-300 !important; -} - -.text-grey-lt-000 { - color: $grey-lt-000 !important; -} - -.text-grey-lt-100 { - color: $grey-lt-100 !important; -} - -.text-grey-lt-200 { - color: $grey-lt-200 !important; -} - -.text-grey-lt-300 { - color: $grey-lt-300 !important; -} - -.text-blue-000 { - color: $blue-000 !important; -} - -.text-blue-100 { - color: $blue-100 !important; -} - -.text-blue-200 { - color: $blue-200 !important; -} - -.text-blue-300 { - color: $blue-300 !important; -} - -.text-green-000 { - color: $green-000 !important; -} - -.text-green-100 { - color: $green-100 !important; -} - -.text-green-200 { - color: $green-200 !important; -} - -.text-green-300 { - color: $green-300 !important; -} - -.text-purple-000 { - color: $purple-000 !important; -} - -.text-purple-100 { - color: $purple-100 !important; -} - -.text-purple-200 { - color: $purple-200 !important; -} - -.text-purple-300 { - color: $purple-300 !important; -} - -.text-yellow-000 { - color: $yellow-000 !important; -} - -.text-yellow-100 { - color: $yellow-100 !important; -} - -.text-yellow-200 { - color: $yellow-200 !important; -} - -.text-yellow-300 { - color: $yellow-300 !important; -} - -.text-red-000 { - color: $red-000 !important; -} - -.text-red-100 { - color: $red-100 !important; -} - -.text-red-200 { - color: $red-200 !important; -} - -.text-red-300 { - color: $red-300 !important; -} - -// Background colors - -.bg-grey-dk-000 { - background-color: $grey-dk-000 !important; -} - -.bg-grey-dk-100 { - background-color: $grey-dk-100 !important; -} - -.bg-grey-dk-200 { - background-color: $grey-dk-200 !important; -} - -.bg-grey-dk-250 { - background-color: $grey-dk-250 !important; -} - -.bg-grey-dk-300 { - background-color: $grey-dk-300 !important; -} - -.bg-grey-lt-000 { - background-color: $grey-lt-000 !important; -} - -.bg-grey-lt-100 { - background-color: $grey-lt-100 !important; -} - -.bg-grey-lt-200 { - background-color: $grey-lt-200 !important; -} - -.bg-grey-lt-300 { - background-color: $grey-lt-300 !important; -} - -.bg-blue-000 { - background-color: $blue-000 !important; -} - -.bg-blue-100 { - background-color: $blue-100 !important; -} - -.bg-blue-200 { - background-color: $blue-200 !important; -} - -.bg-blue-300 { - background-color: $blue-300 !important; -} - -.bg-green-000 { - background-color: $green-000 !important; -} - -.bg-green-100 { - background-color: $green-100 !important; -} - -.bg-green-200 { - background-color: $green-200 !important; -} - -.bg-green-300 { - background-color: $green-300 !important; -} - -.bg-purple-000 { - background-color: $purple-000 !important; -} - -.bg-purple-100 { - background-color: $purple-100 !important; -} - -.bg-purple-200 { - background-color: $purple-200 !important; -} - -.bg-purple-300 { - background-color: $purple-300 !important; -} - -.bg-yellow-000 { - background-color: $yellow-000 !important; -} - -.bg-yellow-100 { - background-color: $yellow-100 !important; -} - -.bg-yellow-200 { - background-color: $yellow-200 !important; -} - -.bg-yellow-300 { - background-color: $yellow-300 !important; -} - -.bg-red-000 { - background-color: $red-000 !important; -} - -.bg-red-100 { - background-color: $red-100 !important; -} - -.bg-red-200 { - background-color: $red-200 !important; -} - -.bg-red-300 { - background-color: $red-300 !important; -} diff --git a/docs/_sass/utilities/_layout.scss b/docs/_sass/utilities/_layout.scss deleted file mode 100644 index 37ebe42..0000000 --- a/docs/_sass/utilities/_layout.scss +++ /dev/null @@ -1,95 +0,0 @@ -// stylelint-disable primer/selector-no-utility, primer/no-override -// -// Utility classes for layout -// - -// Display - -.d-block { - display: block !important; -} -.d-flex { - display: flex !important; -} -.d-inline { - display: inline !important; -} -.d-inline-block { - display: inline-block !important; -} -.d-none { - display: none !important; -} - -@each $media-query in map-keys($media-queries) { - @for $i from 1 through length($spacers) { - @include mq($media-query) { - $size: #{map-get($spacers, sp-#{$i - 1})}; - $scale: #{$i - 1}; - - // .d-sm-block, .d-md-none, .d-lg-inline - .d-#{$media-query}-block { - display: block !important; - } - .d-#{$media-query}-flex { - display: flex !important; - } - .d-#{$media-query}-inline { - display: inline !important; - } - .d-#{$media-query}-inline-block { - display: inline-block !important; - } - .d-#{$media-query}-none { - display: none !important; - } - } - } -} - -// Horizontal alignment - -.float-left { - float: left !important; -} - -.float-right { - float: right !important; -} - -.flex-justify-start { - justify-content: flex-start !important; -} - -.flex-justify-end { - justify-content: flex-end !important; -} - -.flex-justify-between { - justify-content: space-between !important; -} - -.flex-justify-around { - justify-content: space-around !important; -} - -// Vertical alignment - -.v-align-baseline { - vertical-align: baseline !important; -} -.v-align-bottom { - vertical-align: bottom !important; -} -.v-align-middle { - vertical-align: middle !important; -} -.v-align-text-bottom { - vertical-align: text-bottom !important; -} -.v-align-text-top { - vertical-align: text-top !important; -} -.v-align-top { - vertical-align: top !important; -} diff --git a/docs/_sass/utilities/_lists.scss b/docs/_sass/utilities/_lists.scss deleted file mode 100644 index c7b2293..0000000 --- a/docs/_sass/utilities/_lists.scss +++ /dev/null @@ -1,17 +0,0 @@ -// -// Utility classes for lists -// - -// stylelint-disable primer/selector-no-utility, primer/no-override, selector-max-type - -.list-style-none { - padding: 0 !important; - margin: 0 !important; - list-style: none !important; - - li { - &::before { - display: none !important; - } - } -} diff --git a/docs/_sass/utilities/_spacing.scss b/docs/_sass/utilities/_spacing.scss deleted file mode 100644 index 162f801..0000000 --- a/docs/_sass/utilities/_spacing.scss +++ /dev/null @@ -1,165 +0,0 @@ -// -// Utility classes for margins and padding -// - -// scss-lint:disable SpaceAfterPropertyName -// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility, primer/no-override - -// Margin spacer utilities - -.mx-auto { - margin-right: auto !important; - margin-left: auto !important; -} - -@for $i from 1 through length($spacers) { - $size: #{map-get($spacers, sp-#{$i - 1})}; - $scale: #{$i - 1}; - - // .m-0, .m-1, .m-2... - .m-#{$scale} { - margin: #{$size} !important; - } - .mt-#{$scale} { - margin-top: #{$size} !important; - } - .mr-#{$scale} { - margin-right: #{$size} !important; - } - .mb-#{$scale} { - margin-bottom: #{$size} !important; - } - .ml-#{$scale} { - margin-left: #{$size} !important; - } - - .mx-#{$scale} { - margin-right: #{$size} !important; - margin-left: #{$size} !important; - } - - .my-#{$scale} { - margin-top: #{$size} !important; - margin-bottom: #{$size} !important; - } - - .mxn-#{$scale} { - margin-right: -#{$size} !important; - margin-left: -#{$size} !important; - } - .mx-#{$scale}-auto { - margin-right: auto !important; - margin-left: auto !important; - } -} - -@each $media-query in map-keys($media-queries) { - @for $i from 1 through length($spacers) { - @include mq($media-query) { - $size: #{map-get($spacers, sp-#{$i - 1})}; - $scale: #{$i - 1}; - - // .m-sm-0, .m-md-1, .m-lg-2... - .m-#{$media-query}-#{$scale} { - margin: #{$size} !important; - } - .mt-#{$media-query}-#{$scale} { - margin-top: #{$size} !important; - } - .mr-#{$media-query}-#{$scale} { - margin-right: #{$size} !important; - } - .mb-#{$media-query}-#{$scale} { - margin-bottom: #{$size} !important; - } - .ml-#{$media-query}-#{$scale} { - margin-left: #{$size} !important; - } - - .mx-#{$media-query}-#{$scale} { - margin-right: #{$size} !important; - margin-left: #{$size} !important; - } - - .my-#{$media-query}-#{$scale} { - margin-top: #{$size} !important; - margin-bottom: #{$size} !important; - } - - .mxn-#{$media-query}-#{$scale} { - margin-right: -#{$size} !important; - margin-left: -#{$size} !important; - } - } - } -} - -// Padding spacer utilities - -@for $i from 1 through length($spacers) { - $size: #{map-get($spacers, sp-#{$i - 1})}; - $scale: #{$i - 1}; - - // .p-0, .p-1, .p-2... - .p-#{$scale} { - padding: #{$size} !important; - } - .pt-#{$scale} { - padding-top: #{$size} !important; - } - .pr-#{$scale} { - padding-right: #{$size} !important; - } - .pb-#{$scale} { - padding-bottom: #{$size} !important; - } - .pl-#{$scale} { - padding-left: #{$size} !important; - } - - .px-#{$scale} { - padding-right: #{$size} !important; - padding-left: #{$size} !important; - } - - .py-#{$scale} { - padding-top: #{$size} !important; - padding-bottom: #{$size} !important; - } -} - -@each $media-query in map-keys($media-queries) { - @include mq($media-query) { - @for $i from 1 through length($spacers) { - $size: #{map-get($spacers, sp-#{$i - 1})}; - $scale: #{$i - 1}; - - // .p-sm-0, .p-md-1, .p-lg-2... - .p-#{$media-query}-#{$scale} { - padding: #{$size} !important; - } - .pt-#{$media-query}-#{$scale} { - padding-top: #{$size} !important; - } - .pr-#{$media-query}-#{$scale} { - padding-right: #{$size} !important; - } - .pb-#{$media-query}-#{$scale} { - padding-bottom: #{$size} !important; - } - .pl-#{$media-query}-#{$scale} { - padding-left: #{$size} !important; - } - - .px-#{$media-query}-#{$scale} { - padding-right: #{$size} !important; - padding-left: #{$size} !important; - } - - .py-#{$media-query}-#{$scale} { - padding-top: #{$size} !important; - padding-bottom: #{$size} !important; - } - } - } -} diff --git a/docs/_sass/utilities/_typography.scss b/docs/_sass/utilities/_typography.scss deleted file mode 100644 index 2397acb..0000000 --- a/docs/_sass/utilities/_typography.scss +++ /dev/null @@ -1,91 +0,0 @@ -// -// Utility classes for typography -// - -// stylelint-disable primer/selector-no-utility, primer/no-override - -.fs-1 { - @include fs-1; -} - -.fs-2 { - @include fs-2; -} - -.fs-3 { - @include fs-3; -} - -.fs-4 { - @include fs-4; -} - -.fs-5 { - @include fs-5; -} - -.fs-6 { - @include fs-6; -} - -.fs-7 { - @include fs-7; -} - -.fs-8 { - @include fs-8; -} - -.fs-9 { - @include fs-9; -} - -.fs-10 { - @include fs-10; -} - -.fw-300 { - font-weight: 300 !important; -} - -.fw-400 { - font-weight: 400 !important; -} - -.fw-500 { - font-weight: 500 !important; -} - -.fw-700 { - font-weight: 700 !important; -} - -.lh-0 { - line-height: 0 !important; -} - -.lh-default { - line-height: $body-line-height; -} - -.lh-tight { - line-height: $body-heading-line-height; -} - -.ls-5 { - letter-spacing: 0.05em !important; -} - -.ls-10 { - letter-spacing: 0.1em !important; -} - -.ls-0 { - letter-spacing: 0 !important; -} - -.text-uppercase { - text-transform: uppercase !important; -} - -// stylelint-enable primer/selector-no-utility diff --git a/docs/_sass/utilities/utilities.scss b/docs/_sass/utilities/utilities.scss deleted file mode 100644 index 6c25bdf..0000000 --- a/docs/_sass/utilities/utilities.scss +++ /dev/null @@ -1,5 +0,0 @@ -@import "./colors"; -@import "./layout"; -@import "./typography"; -@import "./lists"; -@import "./spacing"; diff --git a/docs/_sass/vendor/normalize.scss/README.md b/docs/_sass/vendor/normalize.scss/README.md deleted file mode 100644 index 7af1714..0000000 --- a/docs/_sass/vendor/normalize.scss/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# normalize.scss - -Normalize.scss is an SCSS copy of [normalize.css](http://necolas.github.io/normalize.css), a customisable CSS file that makes browsers render all elements more consistently and in line with modern standards. - -The [normalize.scss fork](https://github.com/guerrero/normalize.scss) of [normalize.css](http://necolas.github.io/normalize.css) was archived in 2014, and has not been updated since v0.1.0. - -[View the normalize.css test file](http://necolas.github.io/normalize.css/latest/test.html) diff --git a/docs/_sass/vendor/normalize.scss/normalize.scss b/docs/_sass/vendor/normalize.scss/normalize.scss deleted file mode 100644 index 192eb9c..0000000 --- a/docs/_sass/vendor/normalize.scss/normalize.scss +++ /dev/null @@ -1,349 +0,0 @@ -/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */ - -/* Document - ========================================================================== */ - -/** - * 1. Correct the line height in all browsers. - * 2. Prevent adjustments of font size after orientation changes in iOS. - */ - -html { - line-height: 1.15; /* 1 */ - -webkit-text-size-adjust: 100%; /* 2 */ -} - -/* Sections - ========================================================================== */ - -/** - * Remove the margin in all browsers. - */ - -body { - margin: 0; -} - -/** - * Render the `main` element consistently in IE. - */ - -main { - display: block; -} - -/** - * Correct the font size and margin on `h1` elements within `section` and - * `article` contexts in Chrome, Firefox, and Safari. - */ - -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -/* Grouping content - ========================================================================== */ - -/** - * 1. Add the correct box sizing in Firefox. - * 2. Show the overflow in Edge and IE. - */ - -hr { - box-sizing: content-box; /* 1 */ - height: 0; /* 1 */ - overflow: visible; /* 2 */ -} - -/** - * 1. Correct the inheritance and scaling of font size in all browsers. - * 2. Correct the odd `em` font sizing in all browsers. - */ - -pre { - font-family: monospace, monospace; /* 1 */ - font-size: 1em; /* 2 */ -} - -/* Text-level semantics - ========================================================================== */ - -/** - * Remove the gray background on active links in IE 10. - */ - -a { - background-color: transparent; -} - -/** - * 1. Remove the bottom border in Chrome 57- - * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari. - */ - -abbr[title] { - border-bottom: none; /* 1 */ - text-decoration: underline; /* 2 */ - text-decoration: underline dotted; /* 2 */ -} - -/** - * Add the correct font weight in Chrome, Edge, and Safari. - */ - -b, -strong { - font-weight: bolder; -} - -/** - * 1. Correct the inheritance and scaling of font size in all browsers. - * 2. Correct the odd `em` font sizing in all browsers. - */ - -code, -kbd, -samp { - font-family: monospace, monospace; /* 1 */ - font-size: 1em; /* 2 */ -} - -/** - * Add the correct font size in all browsers. - */ - -small { - font-size: 80%; -} - -/** - * Prevent `sub` and `sup` elements from affecting the line height in - * all browsers. - */ - -sub, -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sub { - bottom: -0.25em; -} - -sup { - top: -0.5em; -} - -/* Embedded content - ========================================================================== */ - -/** - * Remove the border on images inside links in IE 10. - */ - -img { - border-style: none; -} - -/* Forms - ========================================================================== */ - -/** - * 1. Change the font styles in all browsers. - * 2. Remove the margin in Firefox and Safari. - */ - -button, -input, -optgroup, -select, -textarea { - font-family: inherit; /* 1 */ - font-size: 100%; /* 1 */ - line-height: 1.15; /* 1 */ - margin: 0; /* 2 */ -} - -/** - * Show the overflow in IE. - * 1. Show the overflow in Edge. - */ - -button, -input { /* 1 */ - overflow: visible; -} - -/** - * Remove the inheritance of text transform in Edge, Firefox, and IE. - * 1. Remove the inheritance of text transform in Firefox. - */ - -button, -select { /* 1 */ - text-transform: none; -} - -/** - * Correct the inability to style clickable types in iOS and Safari. - */ - -button, -[type="button"], -[type="reset"], -[type="submit"] { - -webkit-appearance: button; -} - -/** - * Remove the inner border and padding in Firefox. - */ - -button::-moz-focus-inner, -[type="button"]::-moz-focus-inner, -[type="reset"]::-moz-focus-inner, -[type="submit"]::-moz-focus-inner { - border-style: none; - padding: 0; -} - -/** - * Restore the focus styles unset by the previous rule. - */ - -button:-moz-focusring, -[type="button"]:-moz-focusring, -[type="reset"]:-moz-focusring, -[type="submit"]:-moz-focusring { - outline: 1px dotted ButtonText; -} - -/** - * Correct the padding in Firefox. - */ - -fieldset { - padding: 0.35em 0.75em 0.625em; -} - -/** - * 1. Correct the text wrapping in Edge and IE. - * 2. Correct the color inheritance from `fieldset` elements in IE. - * 3. Remove the padding so developers are not caught out when they zero out - * `fieldset` elements in all browsers. - */ - -legend { - box-sizing: border-box; /* 1 */ - color: inherit; /* 2 */ - display: table; /* 1 */ - max-width: 100%; /* 1 */ - padding: 0; /* 3 */ - white-space: normal; /* 1 */ -} - -/** - * Add the correct vertical alignment in Chrome, Firefox, and Opera. - */ - -progress { - vertical-align: baseline; -} - -/** - * Remove the default vertical scrollbar in IE 10+. - */ - -textarea { - overflow: auto; -} - -/** - * 1. Add the correct box sizing in IE 10. - * 2. Remove the padding in IE 10. - */ - -[type="checkbox"], -[type="radio"] { - box-sizing: border-box; /* 1 */ - padding: 0; /* 2 */ -} - -/** - * Correct the cursor style of increment and decrement buttons in Chrome. - */ - -[type="number"]::-webkit-inner-spin-button, -[type="number"]::-webkit-outer-spin-button { - height: auto; -} - -/** - * 1. Correct the odd appearance in Chrome and Safari. - * 2. Correct the outline style in Safari. - */ - -[type="search"] { - -webkit-appearance: textfield; /* 1 */ - outline-offset: -2px; /* 2 */ -} - -/** - * Remove the inner padding in Chrome and Safari on macOS. - */ - -[type="search"]::-webkit-search-decoration { - -webkit-appearance: none; -} - -/** - * 1. Correct the inability to style clickable types in iOS and Safari. - * 2. Change font properties to `inherit` in Safari. - */ - -::-webkit-file-upload-button { - -webkit-appearance: button; /* 1 */ - font: inherit; /* 2 */ -} - -/* Interactive - ========================================================================== */ - -/* - * Add the correct display in Edge, IE 10+, and Firefox. - */ - -details { - display: block; -} - -/* - * Add the correct display in all browsers. - */ - -summary { - display: list-item; -} - -/* Misc - ========================================================================== */ - -/** - * Add the correct display in IE 10+. - */ - -template { - display: none; -} - -/** - * Add the correct display in IE 10. - */ - -[hidden] { - display: none; -} diff --git a/docs/about.markdown b/docs/about.markdown deleted file mode 100644 index 961f2c5..0000000 --- a/docs/about.markdown +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: About Us -nav_order: 100 -has_children: false ---- - -# About The AI Alliance - -**MICROSITE_TITLE** is a project of the [WORK_GROUP_NAME](WORK_GROUP_URL){:target="wg"} work group in [The AI Alliance](https://thealliance.ai){:target="ai-alliance"}. - -The AI Alliance is a global collaboration of startups, enterprises, academic, and other research institutions interested in advancing the state of the art, the availability, and the safety of AI technology and uses. The AI Alliance's core projects seek to address substantial cross-community challenges and are an opportunity for contributors to collaborate, build, and make an impact on the future of AI. Core Projects are managed directly by the AI Alliance and governed as described in our [community GitHub repository](https://github.com/The-AI-Alliance/community){:target="community"}. You can find a list of all AI Alliance projects on [our website](https://thealliance.ai/our-work){:target="our-work"}. - -If you have any questions or concerns about this initiative, please contact us at [contact@thealliance.ai](mailto:contact@thealliance.ai). - - -## Other AI Alliance Information - -* [More About the AI Alliance](https://thealliance.ai/about-aia){:target="ai-alliance"} -* [Contact Us](mailto:contact@thealliance.ai) (email) -* Follow us on [LinkedIn](https://www.linkedin.com/company/the-aialliance/){:target="linkedin"} - -## About This Documentation - -This documentation is built with [GitHub Pages](https://pages.github.com/){:target="github-pages"}, which uses [Jekyll](https://github.com/jekyll/jekyll){:target="gh-jekyll"} to serve the website. We use the [Just the Docs](https://just-the-docs.github.io/just-the-docs/){:target="just-the-docs"} Jekyll theme. diff --git a/docs/assets/css/just-the-docs-dark.scss b/docs/assets/css/just-the-docs-dark.scss deleted file mode 100644 index ac92fb1..0000000 --- a/docs/assets/css/just-the-docs-dark.scss +++ /dev/null @@ -1,3 +0,0 @@ ---- ---- -{% include css/just-the-docs.scss.liquid color_scheme="dark" %} diff --git a/docs/assets/css/just-the-docs-default.scss b/docs/assets/css/just-the-docs-default.scss deleted file mode 100644 index 63fde26..0000000 --- a/docs/assets/css/just-the-docs-default.scss +++ /dev/null @@ -1,8 +0,0 @@ ---- ---- -{% if site.color_scheme and site.color_scheme != "nil" %} - {% assign color_scheme = site.color_scheme %} -{% else %} - {% assign color_scheme = "light" %} -{% endif %} -{% include css/just-the-docs.scss.liquid color_scheme=color_scheme %} diff --git a/docs/assets/css/just-the-docs-light.scss b/docs/assets/css/just-the-docs-light.scss deleted file mode 100644 index ac69688..0000000 --- a/docs/assets/css/just-the-docs-light.scss +++ /dev/null @@ -1,3 +0,0 @@ ---- ---- -{% include css/just-the-docs.scss.liquid color_scheme="light" %} diff --git a/docs/assets/images/alliance-banner.png b/docs/assets/images/alliance-banner.png deleted file mode 100644 index a971a74..0000000 Binary files a/docs/assets/images/alliance-banner.png and /dev/null differ diff --git a/docs/assets/images/favicon.ico b/docs/assets/images/favicon.ico deleted file mode 100644 index 051f8f7..0000000 Binary files a/docs/assets/images/favicon.ico and /dev/null differ diff --git a/docs/assets/images/just-the-docs.png b/docs/assets/images/just-the-docs.png deleted file mode 100644 index 81c3306..0000000 Binary files a/docs/assets/images/just-the-docs.png and /dev/null differ diff --git a/docs/assets/images/ref-stack.png b/docs/assets/images/ref-stack.png deleted file mode 100644 index 63fdc37..0000000 Binary files a/docs/assets/images/ref-stack.png and /dev/null differ diff --git a/docs/assets/images/search.svg b/docs/assets/images/search.svg deleted file mode 100644 index 421ca4d..0000000 --- a/docs/assets/images/search.svg +++ /dev/null @@ -1 +0,0 @@ -Search diff --git a/docs/assets/js/just-the-docs.js b/docs/assets/js/just-the-docs.js deleted file mode 100644 index c287ec0..0000000 --- a/docs/assets/js/just-the-docs.js +++ /dev/null @@ -1,471 +0,0 @@ ---- ---- -(function (jtd, undefined) { - -// Event handling - -jtd.addEvent = function(el, type, handler) { - if (el.attachEvent) el.attachEvent('on'+type, handler); else el.addEventListener(type, handler); -} -jtd.removeEvent = function(el, type, handler) { - if (el.detachEvent) el.detachEvent('on'+type, handler); else el.removeEventListener(type, handler); -} -jtd.onReady = function(ready) { - // in case the document is already rendered - if (document.readyState!='loading') ready(); - // modern browsers - else if (document.addEventListener) document.addEventListener('DOMContentLoaded', ready); - // IE <= 8 - else document.attachEvent('onreadystatechange', function(){ - if (document.readyState=='complete') ready(); - }); -} - -// Show/hide mobile menu - -function initNav() { - jtd.addEvent(document, 'click', function(e){ - var target = e.target; - while (target && !(target.classList && target.classList.contains('nav-list-expander'))) { - target = target.parentNode; - } - if (target) { - e.preventDefault(); - target.parentNode.classList.toggle('active'); - } - }); - - const siteNav = document.getElementById('site-nav'); - const mainHeader = document.getElementById('main-header'); - const menuButton = document.getElementById('menu-button'); - - jtd.addEvent(menuButton, 'click', function(e){ - e.preventDefault(); - - if (menuButton.classList.toggle('nav-open')) { - siteNav.classList.add('nav-open'); - mainHeader.classList.add('nav-open'); - } else { - siteNav.classList.remove('nav-open'); - mainHeader.classList.remove('nav-open'); - } - }); - - {%- if site.search_enabled != false and site.search.button %} - const searchInput = document.getElementById('search-input'); - const searchButton = document.getElementById('search-button'); - - jtd.addEvent(searchButton, 'click', function(e){ - e.preventDefault(); - - mainHeader.classList.add('nav-open'); - searchInput.focus(); - }); - {%- endif %} -} - -{%- if site.search_enabled != false %} -// Site search - -function initSearch() { - var request = new XMLHttpRequest(); - request.open('GET', '{{ "assets/js/search-data.json" | absolute_url }}', true); - - request.onload = function(){ - if (request.status >= 200 && request.status < 400) { - var docs = JSON.parse(request.responseText); - - lunr.tokenizer.separator = {{ site.search.tokenizer_separator | default: site.search_tokenizer_separator | default: "/[\s\-/]+/" }} - - var index = lunr(function(){ - this.ref('id'); - this.field('title', { boost: 200 }); - this.field('content', { boost: 2 }); - {%- if site.search.rel_url != false %} - this.field('relUrl'); - {%- endif %} - this.metadataWhitelist = ['position'] - - for (var i in docs) { - this.add({ - id: i, - title: docs[i].title, - content: docs[i].content, - {%- if site.search.rel_url != false %} - relUrl: docs[i].relUrl - {%- endif %} - }); - } - }); - - searchLoaded(index, docs); - } else { - console.log('Error loading ajax request. Request status:' + request.status); - } - }; - - request.onerror = function(){ - console.log('There was a connection error'); - }; - - request.send(); -} - -function searchLoaded(index, docs) { - var index = index; - var docs = docs; - var searchInput = document.getElementById('search-input'); - var searchResults = document.getElementById('search-results'); - var mainHeader = document.getElementById('main-header'); - var currentInput; - var currentSearchIndex = 0; - - function showSearch() { - document.documentElement.classList.add('search-active'); - } - - function hideSearch() { - document.documentElement.classList.remove('search-active'); - } - - function update() { - currentSearchIndex++; - - var input = searchInput.value; - if (input === '') { - hideSearch(); - } else { - showSearch(); - // scroll search input into view, workaround for iOS Safari - window.scroll(0, -1); - setTimeout(function(){ window.scroll(0, 0); }, 0); - } - if (input === currentInput) { - return; - } - currentInput = input; - searchResults.innerHTML = ''; - if (input === '') { - return; - } - - var results = index.query(function (query) { - var tokens = lunr.tokenizer(input) - query.term(tokens, { - boost: 10 - }); - query.term(tokens, { - wildcard: lunr.Query.wildcard.TRAILING - }); - }); - - if ((results.length == 0) && (input.length > 2)) { - var tokens = lunr.tokenizer(input).filter(function(token, i) { - return token.str.length < 20; - }) - if (tokens.length > 0) { - results = index.query(function (query) { - query.term(tokens, { - editDistance: Math.round(Math.sqrt(input.length / 2 - 1)) - }); - }); - } - } - - if (results.length == 0) { - var noResultsDiv = document.createElement('div'); - noResultsDiv.classList.add('search-no-result'); - noResultsDiv.innerText = 'No results found'; - searchResults.appendChild(noResultsDiv); - - } else { - var resultsList = document.createElement('ul'); - resultsList.classList.add('search-results-list'); - searchResults.appendChild(resultsList); - - addResults(resultsList, results, 0, 10, 100, currentSearchIndex); - } - - function addResults(resultsList, results, start, batchSize, batchMillis, searchIndex) { - if (searchIndex != currentSearchIndex) { - return; - } - for (var i = start; i < (start + batchSize); i++) { - if (i == results.length) { - return; - } - addResult(resultsList, results[i]); - } - setTimeout(function() { - addResults(resultsList, results, start + batchSize, batchSize, batchMillis, searchIndex); - }, batchMillis); - } - - function addResult(resultsList, result) { - var doc = docs[result.ref]; - - var resultsListItem = document.createElement('li'); - resultsListItem.classList.add('search-results-list-item'); - resultsList.appendChild(resultsListItem); - - var resultLink = document.createElement('a'); - resultLink.classList.add('search-result'); - resultLink.setAttribute('href', doc.url); - resultsListItem.appendChild(resultLink); - - var resultTitle = document.createElement('div'); - resultTitle.classList.add('search-result-title'); - resultLink.appendChild(resultTitle); - - var resultDoc = document.createElement('div'); - resultDoc.classList.add('search-result-doc'); - resultDoc.innerHTML = ''; - resultTitle.appendChild(resultDoc); - - var resultDocTitle = document.createElement('div'); - resultDocTitle.classList.add('search-result-doc-title'); - resultDocTitle.innerHTML = doc.doc; - resultDoc.appendChild(resultDocTitle); - var resultDocOrSection = resultDocTitle; - - if (doc.doc != doc.title) { - resultDoc.classList.add('search-result-doc-parent'); - var resultSection = document.createElement('div'); - resultSection.classList.add('search-result-section'); - resultSection.innerHTML = doc.title; - resultTitle.appendChild(resultSection); - resultDocOrSection = resultSection; - } - - var metadata = result.matchData.metadata; - var titlePositions = []; - var contentPositions = []; - for (var j in metadata) { - var meta = metadata[j]; - if (meta.title) { - var positions = meta.title.position; - for (var k in positions) { - titlePositions.push(positions[k]); - } - } - if (meta.content) { - var positions = meta.content.position; - for (var k in positions) { - var position = positions[k]; - var previewStart = position[0]; - var previewEnd = position[0] + position[1]; - var ellipsesBefore = true; - var ellipsesAfter = true; - for (var k = 0; k < {{ site.search.preview_words_before | default: 5 }}; k++) { - var nextSpace = doc.content.lastIndexOf(' ', previewStart - 2); - var nextDot = doc.content.lastIndexOf('. ', previewStart - 2); - if ((nextDot >= 0) && (nextDot > nextSpace)) { - previewStart = nextDot + 1; - ellipsesBefore = false; - break; - } - if (nextSpace < 0) { - previewStart = 0; - ellipsesBefore = false; - break; - } - previewStart = nextSpace + 1; - } - for (var k = 0; k < {{ site.search.preview_words_after | default: 10 }}; k++) { - var nextSpace = doc.content.indexOf(' ', previewEnd + 1); - var nextDot = doc.content.indexOf('. ', previewEnd + 1); - if ((nextDot >= 0) && (nextDot < nextSpace)) { - previewEnd = nextDot; - ellipsesAfter = false; - break; - } - if (nextSpace < 0) { - previewEnd = doc.content.length; - ellipsesAfter = false; - break; - } - previewEnd = nextSpace; - } - contentPositions.push({ - highlight: position, - previewStart: previewStart, previewEnd: previewEnd, - ellipsesBefore: ellipsesBefore, ellipsesAfter: ellipsesAfter - }); - } - } - } - - if (titlePositions.length > 0) { - titlePositions.sort(function(p1, p2){ return p1[0] - p2[0] }); - resultDocOrSection.innerHTML = ''; - addHighlightedText(resultDocOrSection, doc.title, 0, doc.title.length, titlePositions); - } - - if (contentPositions.length > 0) { - contentPositions.sort(function(p1, p2){ return p1.highlight[0] - p2.highlight[0] }); - var contentPosition = contentPositions[0]; - var previewPosition = { - highlight: [contentPosition.highlight], - previewStart: contentPosition.previewStart, previewEnd: contentPosition.previewEnd, - ellipsesBefore: contentPosition.ellipsesBefore, ellipsesAfter: contentPosition.ellipsesAfter - }; - var previewPositions = [previewPosition]; - for (var j = 1; j < contentPositions.length; j++) { - contentPosition = contentPositions[j]; - if (previewPosition.previewEnd < contentPosition.previewStart) { - previewPosition = { - highlight: [contentPosition.highlight], - previewStart: contentPosition.previewStart, previewEnd: contentPosition.previewEnd, - ellipsesBefore: contentPosition.ellipsesBefore, ellipsesAfter: contentPosition.ellipsesAfter - } - previewPositions.push(previewPosition); - } else { - previewPosition.highlight.push(contentPosition.highlight); - previewPosition.previewEnd = contentPosition.previewEnd; - previewPosition.ellipsesAfter = contentPosition.ellipsesAfter; - } - } - - var resultPreviews = document.createElement('div'); - resultPreviews.classList.add('search-result-previews'); - resultLink.appendChild(resultPreviews); - - var content = doc.content; - for (var j = 0; j < Math.min(previewPositions.length, {{ site.search.previews | default: 3 }}); j++) { - var position = previewPositions[j]; - - var resultPreview = document.createElement('div'); - resultPreview.classList.add('search-result-preview'); - resultPreviews.appendChild(resultPreview); - - if (position.ellipsesBefore) { - resultPreview.appendChild(document.createTextNode('... ')); - } - addHighlightedText(resultPreview, content, position.previewStart, position.previewEnd, position.highlight); - if (position.ellipsesAfter) { - resultPreview.appendChild(document.createTextNode(' ...')); - } - } - } - - {%- if site.search.rel_url != false %} - var resultRelUrl = document.createElement('span'); - resultRelUrl.classList.add('search-result-rel-url'); - resultRelUrl.innerText = doc.relUrl; - resultTitle.appendChild(resultRelUrl); - {%- endif %} - } - - function addHighlightedText(parent, text, start, end, positions) { - var index = start; - for (var i in positions) { - var position = positions[i]; - var span = document.createElement('span'); - span.innerHTML = text.substring(index, position[0]); - parent.appendChild(span); - index = position[0] + position[1]; - var highlight = document.createElement('span'); - highlight.classList.add('search-result-highlight'); - highlight.innerHTML = text.substring(position[0], index); - parent.appendChild(highlight); - } - var span = document.createElement('span'); - span.innerHTML = text.substring(index, end); - parent.appendChild(span); - } - } - - jtd.addEvent(searchInput, 'focus', function(){ - setTimeout(update, 0); - }); - - jtd.addEvent(searchInput, 'keyup', function(e){ - switch (e.keyCode) { - case 27: // When esc key is pressed, hide the results and clear the field - searchInput.value = ''; - break; - case 38: // arrow up - case 40: // arrow down - case 13: // enter - e.preventDefault(); - return; - } - update(); - }); - - jtd.addEvent(searchInput, 'keydown', function(e){ - switch (e.keyCode) { - case 38: // arrow up - e.preventDefault(); - var active = document.querySelector('.search-result.active'); - if (active) { - active.classList.remove('active'); - if (active.parentElement.previousSibling) { - var previous = active.parentElement.previousSibling.querySelector('.search-result'); - previous.classList.add('active'); - } - } - return; - case 40: // arrow down - e.preventDefault(); - var active = document.querySelector('.search-result.active'); - if (active) { - if (active.parentElement.nextSibling) { - var next = active.parentElement.nextSibling.querySelector('.search-result'); - active.classList.remove('active'); - next.classList.add('active'); - } - } else { - var next = document.querySelector('.search-result'); - if (next) { - next.classList.add('active'); - } - } - return; - case 13: // enter - e.preventDefault(); - var active = document.querySelector('.search-result.active'); - if (active) { - active.click(); - } else { - var first = document.querySelector('.search-result'); - if (first) { - first.click(); - } - } - return; - } - }); - - jtd.addEvent(document, 'click', function(e){ - if (e.target != searchInput) { - hideSearch(); - } - }); -} -{%- endif %} - -// Switch theme - -jtd.getTheme = function() { - var cssFileHref = document.querySelector('[rel="stylesheet"]').getAttribute('href'); - return cssFileHref.substring(cssFileHref.lastIndexOf('-') + 1, cssFileHref.length - 4); -} - -jtd.setTheme = function(theme) { - var cssFile = document.querySelector('[rel="stylesheet"]'); - cssFile.setAttribute('href', '{{ "assets/css/just-the-docs-" | absolute_url }}' + theme + '.css'); -} - -// Document ready - -jtd.onReady(function(){ - initNav(); - {%- if site.search_enabled != false %} - initSearch(); - {%- endif %} -}); - -})(window.jtd = window.jtd || {}); - -{% include js/custom.js %} diff --git a/docs/assets/js/vendor/lunr.min.js b/docs/assets/js/vendor/lunr.min.js deleted file mode 100644 index 34b279d..0000000 --- a/docs/assets/js/vendor/lunr.min.js +++ /dev/null @@ -1,6 +0,0 @@ -/** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.6 - * Copyright (C) 2019 Oliver Nightingale - * @license MIT - */ -!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.6",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return void 0===e||null===e?"":e.toString()},e.utils.clone=function(e){if(null===e||void 0===e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i0){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docs/assets/js/zzzz-search-data.json b/docs/assets/js/zzzz-search-data.json deleted file mode 100644 index 6235244..0000000 --- a/docs/assets/js/zzzz-search-data.json +++ /dev/null @@ -1,72 +0,0 @@ ---- -permalink: /assets/js/search-data.json ---- -{ -{%- assign i = 0 -%} -{%- assign pages_array = '' | split: '' -%} -{%- assign pages_array = pages_array | push: site.html_pages -%} -{%- if site.just_the_docs.collections -%} - {%- for collection_entry in site.just_the_docs.collections -%} - {%- assign collection_key = collection_entry[0] -%} - {%- assign collection_value = collection_entry[1] -%} - {%- assign collection = site[collection_key] -%} - {%- if collection_value.search_exclude != true -%} - {%- assign pages_array = pages_array | push: collection -%} - {%- endif -%} - {%- endfor -%} -{%- endif -%} -{%- for pages in pages_array -%} - {%- for page in pages -%} - {%- if page.title and page.search_exclude != true -%} - {%- assign page_content = page.content -%} - {%- assign heading_level = site.search.heading_level | default: 2 -%} - {%- for j in (2..heading_level) -%} - {%- assign tag = '' -%} - {%- assign title = titleAndContent[0] | replace_first: '>', '

' | split: '

' -%} - {%- assign title = title[1] | strip_html -%} - {%- assign content = titleAndContent[1] -%} - {%- assign url = page.url -%} - {%- if title == page.title and parts[0] == '' -%} - {%- assign title_found = true -%} - {%- else -%} - {%- assign id = titleAndContent[0] -%} - {%- assign id = id | split: 'id="' -%} - {%- if id.size == 2 -%} - {%- assign id = id[1] -%} - {%- assign id = id | split: '"' -%} - {%- assign id = id[0] -%} - {%- capture url -%}{{ url | append: '#' | append: id }}{%- endcapture -%} - {%- endif -%} - {%- endif -%} - {%- unless i == 0 -%},{%- endunless -%} - "{{ i }}": { - "doc": {{ page.title | jsonify }}, - "title": {{ title | jsonify }}, - "content": {{ content | replace: ' **Tip:** Use the search box at the top of this page to find specific content. - -> **TODO:** This is a work-in-progress website for the MICROSITE_TITLE. - -> **NOTE:** The "boilerplate" text on this page mixes content you might want to use, as well as tips on writing Markdown. - -TODO: add more "welcome" content for your site here... - -This site is organized into the following sections [^1] (with an example footnote): - -* [TODO - second top-level page]({{site.baseurl}}/second_page) - * [alternative link](second_page) -* [TODO - nested]({{site.baseurl}}/nested/nested) - -Note how relative links are written. For siblings (like the next set of bullets...) or subpages, you don't have to use the `{{site.baseurl}}` prefix (like the `alternative link`), but use `{{site.baseurl}}` instead of relative navigation hacks like `../../foo/bar`. - -Additional links: [^2] - -* [Contributing]({{site.baseurl}}/contributing): We welcome your contributions! Here's how you can contribute. -* [About Us]({{site.baseurl}}/about): More about the AI Alliance and this project. -* [The AI Alliance](https://thealliance.ai){:target="ai-alliance"}: The AI Alliance website. -* [Project GitHub Repo](https://github.com/The-AI-Alliance/REPO_NAME){:target="repo"} - -Note our convention that external URLs include a target, specified with `{:target="some_name"}`. In fact, Jekyll is configured in `_config.yml` to use the `jekyll-target-blank` plugin, which automatically opens external links in a new tab, named `blank`. This is good enough, but it also means that every link you click will open in the same tab. So, explicitly specifying a `:target` provides a nicer experience. You will also notice that external links get a little box and arrow adornment. This is done automatically through a clever CSS hack in `docs/_includes/css/custom.scss.liquid`. - -A table example using standard Markdown and showing how to set the desired alignment. (The extra whitespace in the source is only for easier readability.): - -| Column 1 (Left Aligned) | Column 2 (Centered) | Column 3 (Numbers - Right Aligned) | -| :------- | :------------------: | -----: | -| text 1 | centered | 1 | -| text 2 | also centered | 20 | -| text 3 | and this is centered | 300 | - -### Version History - -| Version | Date | -| :------- | :--------- | -| V0.0.1 | YMD_TSTAMP | - -[^1]: Use `[^N]` (for increasing `N` values) to mark "footnote #N" in text, as shown above. This is an example footnote with a link to it from above, and a link at the end of the footnote to go back to the point in the text (the "curled" arrow). **WARNING**, you must include the colon in the footnote definition as shown here, `[^1]:`. -[^2]: A second example footnote. Note that you don't need to put a blank line between them; they work like lists. - - -{:toc} diff --git a/docs/nested/nested.markdown b/docs/nested/nested.markdown deleted file mode 100644 index 8fa3686..0000000 --- a/docs/nested/nested.markdown +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: default -title: TODO - nested section "index" page -nav_order: 20 -has_children: true ---- - -# TODO - nested section "index" page - -TODO replace with your content (or delete folder). - -An example of a nested section. This is the "index" page for the nested section. Note that URLs elsewhere, like in `../index.markdown` are written `{{site.baseurl}}/nested/nested`. - -Note the [`nested_child`]({{site.baseurl}}/nested/nested_child/) page. - - -{:toc} diff --git a/docs/nested/nested_child.markdown b/docs/nested/nested_child.markdown deleted file mode 100644 index 5260dbc..0000000 --- a/docs/nested/nested_child.markdown +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: TODO - nested child page -nav_order: 210 -parent: TODO - nested section "index" page -has_children: false ---- - -# TODO - nested child page - -An example of a child page in a nested section. Note the informal convention for the ordering number and `has_children` setting in the Markdown file's header. \ No newline at end of file diff --git a/docs/second_page.markdown b/docs/second_page.markdown deleted file mode 100644 index be53b36..0000000 --- a/docs/second_page.markdown +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: TODO - Second Page -nav_order: 20 -has_children: false ---- - -# TODO - Second Page - -TODO - your "second" content - diff --git a/finish-microsite.sh b/finish-microsite.sh deleted file mode 100755 index 45d6824..0000000 --- a/finish-microsite.sh +++ /dev/null @@ -1,267 +0,0 @@ -#!/usr/bin/env zsh -#------------------------------------------------------------------------ -# Convert this microsite template into your desired microsite. -# Run finish-microsite.sh -h to see the required arguments and options. -# Note: This file defaults to use zsh. If you don't have zsh, but you -# DO have bash v5+, then use /path/to/bash finish-microsite.sh. -#------------------------------------------------------------------------ -set -e - -ymdformat="%Y-%m-%d" -tsformat="$ymdformat %H:%M %z" -script=$0 -dir=$(dirname $script) -cfg="$dir/docs/_config.yml" -index="$dir/docs/index.markdown" -work_branch=main -publish_branch=latest -fa_max_number=6 # FAs numbered from 1 to max_... -focus_areas_url="https://thealliance.ai/focus-areas" - -declare -A fa_names -fa_names["FA1"]="FA1: Skills and Education" -fa_names["FA2"]="FA2: Trust and Safety" -fa_names["FA3"]="FA3: Applications and Tools" -fa_names["FA4"]="FA4: Hardware Enablement" -fa_names["FA5"]="FA5: Foundation Models and Datasets" -fa_names["FA6"]="FA6: Advocacy" - -declare -A fa_url_names -fa_url_names["FA1"]=skills-education -fa_url_names["FA2"]=trust-and-safety -fa_url_names["FA3"]=applications-and-tools -fa_url_names["FA4"]=hardware-enablement -fa_url_names["FA5"]=foundation-models -fa_url_names["FA6"]=advocacy - -help() { - cat << EOF -$script [-h|--help] [-n|--noop] [--ns|--next-steps] \ - [--repo-name|-r name] \ - --microsite-title|--site-title|-t title \ - --work-group|-w work_group - -Where the options and required arguments are the following: --h | --help Print this message and exit. --n | --noop Just print the commands but don't run them. --s | --next-steps At the end of running this script to create a new repo, - some information about "next steps" is printed. If you want to see - this information again, run this script again just using this flag. ---repo-name | -r name The name of GitHub repo. If you are running this script in the - repo's root directory, its name will be used, by default. ---repo-dir | -d name The absolute path to the repo root directory or the relative - path from the current directory. Only needed when you aren't - running this script in the repo root directory. ---work-group-url | -u work_group_url - The URL of the work group sponsoring this site. - If one of the "FA#" arguments is used for --work-group (see below), - then a known URL will be used. If the URL isn't known for the - specified workgroup and one isn't specified, the default URL for - focus areas will be used: $focus_areas_url - -These arguments are required, but they can appear in any order. See the example below: - ---microsite-title | --site-title | -t title - The title of the microsite. ---work-group | -w work_group - The name of work group sponsoring this site. - -For example, suppose you want to create a microsite with the title "AI for Evil Project", -under the FA2: Trust and Safety work group, then use the following the command: - -$script --repo-name ai-for-evil-project --microsite-title "AI for Evil Project" --work-group fa2 - -Note that just specifying "fa1" or "FA1", etc. for any of the focus areas will result in the -following names being used: - -EOF - -for i in {1..$fa_max_number} -do - # By "coincidence" it works to use the $focus_areas_url as a prefix! - printf "%-35s (URL: %s)\n" "${fa_names["FA$i"]}" "${focus_areas_url}/${fa_url_names["FA$i"]}" -done - - cat < 0 ]] && error "${missing[@]}" - -info "Updating data in the repo:" -info " Repo name: $repo_name" -[[ -n "$repo_dir" ]] && \ - info " Repo dir: $repo_dir" -info " Title: $microsite_title" -info " Work group: $work_group" -[[ -n "$work_group_url" ]] && \ - info " Work group URL: $work_group_url" - -info "Replacing macro placeholders with values:" -[[ -z "$ymdtimestamp" ]] && ymdtimestamp=$(date +"$ymdformat") -date -j -f "$ymdformat" +"$ymdformat" "$ymdtimestamp" > /dev/null 2>&1 -[[ $? -ne 0 ]] && error "Invalid YMD timestamp format for timestamp: $ymdtimestamp" "Required format: $ymdformat" -[[ -z "$timestamp" ]] && timestamp=$(date +"$tsformat") -date -j -f "$tsformat" +"$tsformat" "$timestamp" > /dev/null 2>&1 -[[ $? -ne 0 ]] && error "Invalid timestamp format for timestamp: $timestamp" "Required format: $tsformat" - -[[ -n "$repo_dir" ]] && $NOOP cd "$repo_dir" - -files=( - Makefile - README.md - publish-website.sh - update-main.sh - docs/_config.yml -) -markdown_files=($(find docs -name '*.markdown')) -html_files=($(find docs/_layouts -name '*.html')) - -info "Replacing macros with correct values:" -info " REPO_NAME: $repo_name" -info " MICROSITE_TITLE: $microsite_title" -info " WORK_GROUP_NAME: $work_group" -info " WORK_GROUP_URL: $work_group_url" -info " YMD_TSTAMP: $ymdtimestamp" -info " TIMESTAMP: $timestamp" -info -info "Processing Files:" - -for file in "${files[@]}" "${markdown_files[@]}" "${html_files[@]}" -do - info " $file" - if [[ -z $NOOP ]] - then - sed -e "s?REPO_NAME?$repo_name?g" \ - -e "s?MICROSITE_TITLE?$microsite_title?g" \ - -e "s?WORK_GROUP_NAME?$work_group?g" \ - -e "s?WORK_GROUP_URL?$work_group_url?g" \ - -e "s?YMD_TSTAMP?$ymdtimestamp?g" \ - -e "s?TIMESTAMP?$timestamp?g" \ - -i ".back" "$file" - else - $NOOP sed ... -i .back $file - fi -done - -info "Delete the backup '*.back' files that were just made." -$NOOP find . -name '*.back' -exec rm {} \; - -info "Committing changes to the main branch." -# Use --no-verify to suppress complaints and nonzero exit when -# there is nothing to commit. -$NOOP git commit --no-verify -m "$0: Committing changes after variable substitution." . - -exists=$(git br -a | grep latest | wc -l) -if [[ $exists -eq 0 ]] -then - info "Create a 'latest' branch, from which the pages will be published." - $NOOP git checkout -b latest -else - info "Merge the changes to the 'latest' branch, from which the pages will be published." - $NOOP git checkout latest - $NOOP git merge main - $NOOP git commit --no-verify -m 'update publication branch, latest, from main branch' . -fi - -info "Switching back to the main branch." -$NOOP git checkout main - -info "Done! The current working directory is $PWD." -next_steps diff --git a/publish-website.sh b/publish-website.sh deleted file mode 100755 index bf1a4dc..0000000 --- a/publish-website.sh +++ /dev/null @@ -1,180 +0,0 @@ -#!/usr/bin/env zsh -#------------------------------------------------------------------------ -# Publish a new version of the site. -# This script can be used to publish a new version of this site, which in -# this case means bump the version number and corresponding new timestamp: -# 1. _config.yaml: sets the value shown in the page footers. -# 2. docs/index.markdown: -# a. Authors and latest version table at the top of the page, if present -# b. The history table of versions and timestamps at the bottom, if present. -# -# NOTES: -# 1. While recommended, it's not required to use this script... -# 2. This version of this script assumes the newer format for the history -# table, with just the most recent version at the top of docs/index.markdown -# and the full history in a separate table at the bottom. -#------------------------------------------------------------------------ - -tsformat="%Y-%m-%d %H:%M %z" -script=$0 -dir=$(dirname $script) -cfg="$dir/docs/_config.yml" -index="$dir/docs/index.markdown" -work_branch=main -publish_branch=latest - -help() { - cat << EOF -$script [-h|--help] [-n|--noop] [-v|--version V] [-t|--timestamp T] - -Where the options are the following: --h | --help Print this message and exit --n | --noop Just print the commands but don't make changes. --v | --version V Use version string "V", which should be of the format - "X.Y.Z". Without this option the current value of - "last_version" in _config.yml is extracted (e.g., 1.0.1) - and the last digit is incremented. --t | --timestamp "T" Use this timestamp "T", which you'll need to quote on - the command line, because it must be of the form - "$tsformat". Without this option, the current - system time is used. ---no-commit Edit the files, but don't commit the changes to the repo. -EOF -} - -error() { - for arg in "$@" - do - echo "ERROR: $arg" - done - help - exit 1 -} - -let no_commit=1 -while [[ $# -gt 0 ]] -do - case $1 in - -h|--h*) - help - exit 0 - ;; - -n|--noop) - NOOP=echo - ;; - -v|--v*) - shift - version="$1" - ;; - -t|--t*) - shift - timestamp="$1" - ;; - --no-commit) - let no_commit=0 - ;; - *) - error "Unrecognized option: $1" - ;; - esac - shift -done - -[[ -z "$timestamp" ]] && timestamp=$(date +"$tsformat") -date -j -f "$tsformat" +"$tsformat" "$timestamp" > /dev/null 2>&1 -[[ $? -ne 0 ]] && error "Invalid timestamp format for timestamp: $timestamp" "Required format: $tsformat" - -old_version=$(grep last_version "$cfg" | sed -e 's/^[ ]*last_version:[ ]*//') -base=${old_version%.*} -ext=${old_version##*.} -let ext1=$ext+1 -new_default_version=${base}.${ext1} -[[ -z "$version" ]] && version="$new_default_version" - -echo "Using the following values:" -echo "Version: $version (previous version: $old_version)" -echo "Timestamp: $timestamp" - -branch=$(git branch --show-current) -[[ "$branch" != "$work_branch" ]] && error "You must be on the $work_branch branch to run this command." - -cfg_temp=${cfg}.$$ -if [[ -z "$NOOP" ]] -then - sed -e "s/\s*last_version:.*/last_version: $version/" $cfg > $cfg_temp - sed -e "s/\s*last_modified_timestamp:.*/last_modified_timestamp: $timestamp/" $cfg_temp > $cfg - rm $cfg_temp -else - $NOOP "sed -e \"s/\s*last_version:.*/last_version: $version/\" $cfg > $cfg_temp" - $NOOP "sed -e \"s/\s*last_modified_timestamp:.*/last_modified_timestamp: $timestamp/\" $cfg_temp > $cfg" - $NOOP rm $cfg_temp -fi - -# Sanity checks: -if [[ -z $NOOP ]] -then - grep "last_version: $version" $cfg -q || error "New version $version not found in $cfg" - grep "last_modified_timestamp: $timestamp" $cfg -q || error "New timestamp $timestamp not found in $cfg" -fi - -# Update the index page table with versions. -latest_history_line=$(grep '\*\*Last Update\*\*' "$index") -latest_history=$(echo $latest_history_line | sed -e 's/[^V]*V\([^, ]*\).*/\1/') - -if [[ "$latest_history" = "$version" ]] -then - echo "New version ($version) is the same as the old version in $index. Not changing that file." -else - mv $index $index.$$ - found_version_history=false - cat $index.$$ | while read line - do - case $line in - *Last*Update*) - ymd=$(date -j -f "$tsformat" +"%Y-%m-%d" "$timestamp") - echo "| **Last Update** | V$version, $ymd |" - ;; - *Version*Date*) - echo $line - found_version_history=true - ;; - \|\ :---*) - echo $line - if $found_version_history - then - echo "| V$version | $ymd |" - found_version_history=false - fi - ;; - *) - echo "$line" - ;; - esac - done > $index - rm $index.$$ -fi - -# Commit and push the updated config file: -if [[ $no_commit -eq 0 ]] -then - echo "Changes won't be committed to the git repo." - exit 0 -fi - -if [[ "$latest_history" = "$version" ]] -then - $NOOP git commit -s -m "Updated version and timestamps in $cfg" $cfg -else - $NOOP git commit -s -m "Updated version and timestamps in $cfg and $index" $cfg $index -fi -$NOOP git push - -# Merge to latest and push to publish. Also tag it! - -$NOOP git checkout $publish_branch -$NOOP git merge $work_branch -$NOOP git push -$NOOP git tag v${version} -$NOOP git push --tags -$NOOP git checkout $work_branch - diff --git a/update-main.sh b/update-main.sh deleted file mode 100755 index 6384d2c..0000000 --- a/update-main.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env zsh -#------------------------------------------------------------------------ -# A simple script that merges the latest work from "latest" to "main", -# pushes the updates upstream, then switches "latest" again. -# This is mostly useful if you tend to work in "latest", so updates are -# published immediately, and you periodically want to update main. -#------------------------------------------------------------------------ - -git checkout latest -git pull -git checkout main -git pull -git merge latest -git push -git checkout latest