diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index d548f27043..0000000000 --- a/.dockerignore +++ /dev/null @@ -1,7 +0,0 @@ -.dockerignore -.gitignore -AUTHORS -CONTRIBUTING.md -LICENSE -node_modules/ -README.md diff --git a/.firebaserc b/.firebaserc index 05e5cbcbc8..4c0003aef7 100644 --- a/.firebaserc +++ b/.firebaserc @@ -8,7 +8,6 @@ "sz": "sz-flutter", "sz2": "sz-flutter-2", "ft": "flutter-web-staging", - "bt": "flt-test", "ats": "tony-flutter-site", "filiph": "flutter-website-filiph-staging" } diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5c93695e60..38073bb8bc 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -3,21 +3,6 @@ version: 2 updates: - - package-ecosystem: "bundler" - directory: "/" - schedule: - interval: "daily" - labels: - - "auto.dependencies" - - "auto.bundler" - - "lang.ruby" - - package-ecosystem: "docker" - directory: "/" - schedule: - interval: "daily" - labels: - - "auto.dependencies" - - "auto.docker" - package-ecosystem: "github-actions" directory: "/" schedule: diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 08e58ada83..8e424c8e6b 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -23,7 +23,7 @@ jobs: strategy: fail-fast: false matrix: - language: [ 'javascript', 'ruby' ] + language: [ 'javascript' ] # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] # Learn more about CodeQL language support at https://git.io/codeql-language-support diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4fd9d60092..ddb710a694 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -74,8 +74,6 @@ jobs: - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 with: submodules: recursive - - name: Build site - run: make build BUILD_CONFIGS=_config.yml - name: Enable Corepack run: corepack enable - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 @@ -91,6 +89,8 @@ jobs: sdk: stable - name: Fetch Dart dependencies run: dart pub get + - name: Build site + run: dart run flutter_site build - name: Check for broken Markdown link references run: dart run flutter_site check-link-references - name: Check for broken internal links diff --git a/AUTHORS b/AUTHORS index f5c6d8b4df..8e252b68ee 100644 --- a/AUTHORS +++ b/AUTHORS @@ -16,3 +16,4 @@ Gianluca Cesari Hidenori Matsubayashi Pradumna Saraf Alex Li +Parker Lougheed diff --git a/CODEOWNERS b/CODEOWNERS index c42e50e622..533b355101 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -7,12 +7,6 @@ # Covers all web content /src/ @sfshaza2 @atsansone @parlough @domesticmouse @MaryaBelanger -# Covers Jekyll plugins -/src/_plugins/ @khanhnwin @parlough @sfshaza2 @atsansone @domesticmouse @MaryaBelanger - -# Covers website styles -/src/_sass/ @khanhnwin @parlough @sfshaza2 @atsansone @domesticmouse @MaryaBelanger - # Covers website tooling /tool/ @sfshaza2 @atsansone @parlough @khanhnwin @domesticmouse @MaryaBelanger diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5038ba4aab..54aafee168 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,3 @@ - If you would like to contribute to the Flutter project, we’re happy to have your help! Anyone can contribute, whether you’re new to the project or you’ve been around a long time, and whether you self-identify @@ -19,7 +18,7 @@ Flutter](https://github.com/flutter/flutter/blob/main/CONTRIBUTING.md) in the [Flutter SDK](https://github.com/flutter/flutter) repo. We are also happy to accept your PRs to the -[Flutter website](https://github.com/flutter/website/) repo, +[Flutter documentation website](https://github.com/flutter/website/) repo, even if it's just to fix a typo. For ways to get involved in the Flutter community or to learn about us, @@ -31,7 +30,7 @@ We encourage you to reach out and join the conversation. An easy way to send feedback is to "thumbs up" issues important to you in either the issue tracker for the [Flutter SDK and API docs][issues], -or the [flutter.dev website][doc-issues]. +or the [docs.flutter.dev website][doc-issues]. Other ways you can contribute: @@ -42,8 +41,8 @@ Other ways you can contribute: * [Report bugs and request features][issues] * [Report API docs bugs][issues] * [Submit PRs to the Flutter SDK][PRs] -* [Request docs for flutter.dev][doc-issues] -* [Submit PRs to flutter.dev][doc-PRs] +* [Request docs for docs.flutter.dev][doc-issues] +* [Submit PRs to docs.flutter.dev][doc-PRs] * [Follow us on Twitter: @flutterdev](https://twitter.com/flutterdev/) * [Read the Flutter Publication on Medium](https://medium.com/flutter) * [Sign up to Future UX Studies on Flutter](https://flutter.dev/research-signup) diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 2b448a3428..0000000000 --- a/Dockerfile +++ /dev/null @@ -1,51 +0,0 @@ -FROM ruby:3.2.3-slim-bookworm@sha256:97fccffe954d1e0c7fa6634020379417d67435a7f9a7c10b6ef3f49e498307e6 as base - -ENV TZ=US/Pacific -RUN apt-get update && apt-get install -yq --no-install-recommends \ - apt-transport-https \ - build-essential \ - ca-certificates \ - curl \ - git \ - gnupg \ - lsof \ - make \ - rsync \ - unzip \ - xdg-user-dirs \ - && rm -rf /var/lib/apt/lists/* - -WORKDIR /app - -# ============== NODEJS INTSALL ============== -FROM base AS node - -RUN mkdir -p /etc/apt/keyrings \ - && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \ - && echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list \ - && apt-get update -yq \ - && apt-get install nodejs -yq \ - && npm install -g npm # Ensure latest npm - -# ============== BUILD PROD JEKYLL SITE ============== -FROM node AS build - -ENV JEKYLL_ENV=production -ENV RUBY_YJIT_ENABLE=1 -RUN gem install bundler -COPY Gemfile Gemfile.lock ./ -RUN bundle config set force_ruby_platform true -RUN BUNDLE_WITHOUT="test development" bundle install --jobs=4 --retry=2 - -ENV NODE_ENV=production -COPY package.json ./ -RUN npm install - -COPY ./ ./ - -RUN echo 'User-agent: *\nDisallow:\n\nSitemap: https://docs.flutter.dev/sitemap.xml' > src/robots.txt - -ARG BUILD_CONFIGS=_config.yml -ENV BUILD_CONFIGS=$BUILD_CONFIGS -RUN bundle exec jekyll build --config $BUILD_CONFIGS - diff --git a/Gemfile b/Gemfile deleted file mode 100644 index e181a7efca..0000000000 --- a/Gemfile +++ /dev/null @@ -1,13 +0,0 @@ -source 'https://rubygems.org' - -gem 'jekyll', '4.3.3' -gem 'jekyll-sass-converter', '~> 3.0.0' -gem 'webrick' - -# Used for custom _plugins -gem 'activesupport', '~> 7.1.3' -gem 'liquid-tag-parser', '~> 2.0.2' - -group :jekyll_plugins do - gem 'jekyll-toc', '~> 0.18.0' -end diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index fa383da487..0000000000 --- a/Gemfile.lock +++ /dev/null @@ -1,110 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (7.1.3.2) - base64 - bigdecimal - concurrent-ruby (~> 1.0, >= 1.0.2) - connection_pool (>= 2.2.5) - drb - i18n (>= 1.6, < 2) - minitest (>= 5.1) - mutex_m - tzinfo (~> 2.0) - addressable (2.8.6) - public_suffix (>= 2.0.2, < 6.0) - base64 (0.2.0) - bigdecimal (3.1.6) - colorator (1.1.0) - concurrent-ruby (1.2.3) - connection_pool (2.4.1) - drb (2.2.0) - ruby2_keywords - em-websocket (0.5.3) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - eventmachine (1.2.7) - extras (0.3.0) - forwardable-extended (~> 2.5) - ffi (1.16.3) - forwardable-extended (2.6.0) - google-protobuf (3.25.2) - http_parser.rb (0.8.0) - i18n (1.14.1) - concurrent-ruby (~> 1.0) - jekyll (4.3.3) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (~> 1.0) - jekyll-sass-converter (>= 2.0, < 4.0) - jekyll-watch (~> 2.0) - kramdown (~> 2.3, >= 2.3.1) - kramdown-parser-gfm (~> 1.0) - liquid (~> 4.0) - mercenary (>= 0.3.6, < 0.5) - pathutil (~> 0.9) - rouge (>= 3.0, < 5.0) - safe_yaml (~> 1.0) - terminal-table (>= 1.8, < 4.0) - webrick (~> 1.7) - jekyll-sass-converter (3.0.0) - sass-embedded (~> 1.54) - jekyll-toc (0.18.0) - jekyll (>= 3.9) - nokogiri (~> 1.12) - jekyll-watch (2.2.1) - listen (~> 3.0) - kramdown (2.4.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.4) - liquid-tag-parser (2.0.2) - extras (~> 0.3) - liquid (>= 3.0, < 5.0) - listen (3.8.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.4.0) - mini_portile2 (2.8.5) - minitest (5.22.2) - mutex_m (0.2.0) - nokogiri (1.16.2) - mini_portile2 (~> 2.8.2) - racc (~> 1.4) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (5.0.4) - racc (1.7.3) - rake (13.1.0) - rb-fsevent (0.11.2) - rb-inotify (0.10.1) - ffi (~> 1.0) - rexml (3.2.6) - rouge (4.2.0) - ruby2_keywords (0.0.5) - safe_yaml (1.0.5) - sass-embedded (1.70.0) - google-protobuf (~> 3.25) - rake (>= 13.0.0) - terminal-table (3.0.2) - unicode-display_width (>= 1.1.1, < 3) - tzinfo (2.0.6) - concurrent-ruby (~> 1.0) - unicode-display_width (2.5.0) - webrick (1.8.1) - -PLATFORMS - ruby - -DEPENDENCIES - activesupport (~> 7.1.3) - jekyll (= 4.3.3) - jekyll-sass-converter (~> 3.0.0) - jekyll-toc (~> 0.18.0) - liquid-tag-parser (~> 2.0.2) - webrick - -BUNDLED WITH - 2.5.5 diff --git a/Makefile b/Makefile deleted file mode 100644 index ac657521a9..0000000000 --- a/Makefile +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/make -f --include .env - - -all: build clean - -.DEFAULT_GOAL := up -.PHONY: all - -BUILD_COMMIT := $(shell git rev-parse --short HEAD) -BUILD_CONFIGS ?= _config.yml -BUILD_NAME = tmpbuild -BUILD_TAG = "fltbuild:${BUILD_COMMIT}" - -# Build the production image and copy site build to local. -# This will reset and also clean up after finished. -# Usage: `make build` -build: - make clean - DOCKER_BUILDKIT=1 docker build --rm --no-cache --target build \ - --build-arg BUILD_CONFIGS=${BUILD_CONFIGS} -t ${BUILD_TAG} . - docker run --rm -d --name ${BUILD_NAME} -t ${BUILD_TAG} - docker cp ${BUILD_NAME}:/app/_site _site - docker stop ${BUILD_NAME} - docker rmi -f ${BUILD_TAG} - -# Clean all caches, and test/build files -clean: - rm -rf _site .jekyll* src/.jekyll* *.log tmp .dart_tool diff --git a/README.md b/README.md index 62973272a2..048096d2a8 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,22 @@ [Flutter logo]: https://github.com/dart-lang/site-shared/blob/main/src/_assets/image/flutter/icon/64.png?raw=1 -# [Flutter][] website +# [Flutter][] documentation website + +The [documentation site][Flutter] for the [Flutter framework][], +built with [Eleventy][] and hosted on [Firebase][]. [![Build Status][]][Repo on GitHub Actions] [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/flutter/website/badge)](https://deps.dev/project/github/flutter%2Fwebsite) +[Flutter framework]: https://flutter.dev +[Eleventy]: https://11ty.dev/ +[Firebase]: https://firebase.google.com/ + [Build Status]: https://github.com/flutter/website/workflows/build/badge.svg [Flutter]: https://docs.flutter.dev/ [Repo on GitHub Actions]: https://github.com/flutter/website/actions?query=workflow%3Abuild+branch%3Amain -## Table of contents - -* [Issues, bugs, and requests](#issues-bugs-and-requests) -* [Before you submit a PR](#before-you-submit-a-pr) -* [Before you build this site](#before-you-build-this-site) -* [Creating and/or editing DartPad example code](#creating-andor-editing-dartpad-example-code) -* [Writing for flutter.dev](#writing-for-flutterdev) - ## Issues, bugs, and requests We welcome contributions and feedback on our website. @@ -62,120 +61,277 @@ But here are a few notes to keep in mind before you submit a PR: [Google Developer Documentation Style Guidelines]: https://developers.google.com/style -## Before you build this site -For changes beyond simple text and CSS tweaks, -we recommend building the site. +## Contributing + +To update this site, fork the repo, make your changes, +and generate a pull request. +For small, contained changes (such as style and typo fixes), +you probably don't need to build this site. +Often you can make changes using the GitHub UI. +If needed, we can stage the changes automatically in your pull request. + +> [!IMPORTANT] +> If you are cloning this repository locally, +> follow the below instruction on cloning with its submodule. + +If your change involves code samples, adds/removes pages, or affects navigation, +do consider building and test your work before submitting. + +If you want or need to build the site, follow the steps below. + +## Build the site + +For changes beyond simple text and CSS tweaks, +we recommend running the site locally to +enable an edit-refresh cycle. + +### Get the prerequisites + +Install the following tools to build and develop the site: + +#### Flutter + +The latest stable release of Flutter, which includes Dart, +is required to build the site and run its tooling. +If you don't have Flutter or need to update, follow the +instructions at [Install Flutter][] or [Upgrading Flutter][]. + +If you already have Flutter installed, verify it's on your path +and already the latest stable version: -> [!WARNING] -> Support for building the site locally has temporarily been removed. -> This README will be updated with the new building details soon. -> -> Until then, please rely on automatic staging in pull requests. -> Thanks for your patience! +```console +flutter --version +``` + +[Install Flutter]: https://docs.flutter.dev/get-started +[Upgrading Flutter]: https://docs.flutter.dev/release/upgrade + +#### Node.js + +The **latest** stable LTS release of Node.js is required to build the site. +If you don't have Node.js or need to update, download your +computer's corresponding version and follow the instructions +from the [Node.js download archive][]. +If you prefer, you can use a version manager such as [nvm][], +and run `nvm install` from the repository's root directory. + +If you already have Node installed, verify it's available on your path +and already the latest stable version _(currently `20.10` or later)_: + +```console +node --version +``` + +If your version is out of date, +follow the update instructions for how you originally installed it. -### Clone this repo _and_ its submodules +[Node.js download archive]: https://nodejs.org/en/download/ +[nvm]: https://github.com/nvm-sh/nvm -> **Note:** This repo has git _submodules_, -> which affects how you clone it. +### Clone this repo and its submodules + +> [!NOTE] +> This repository has git _submodules_, which affects how you clone it. > The GitHub documentation has general help on > [forking][] and [cloning][] repos. -[cloning]: https://help.github.com/articles/cloning-a-repository -[forking]: https://docs.github.com/en/get-started/quickstart/fork-a-repo - -If you're outside of the Flutter organization, -we recommend you **create a fork** of the repo under your own account, -and then submit a PR from that fork. +If you're not a member of the Flutter organization, +we recommend you **create a fork** of this repo under your own account, +and then submit a PR from that fork. -Once you have a fork (or you're a Flutter org member), +Once you have a fork (or you're a Flutter org member), _choose one_ of the following submodule-cloning techniques: -- Clone the repo and its submodule at the same - using the `--recurse-submodules` option: -- - ```bash - git clone --recurse-submodules https://github.com//website.git - ``` +1. Clone the repo and its submodule at the same time + using the `--recurse-submodules` option: - OR + ```console + git clone --recurse-submodules https://github.com/flutter/website.git + ``` -- If you've already cloned the repo without its submodule, - then run this command from the repo root: +2. If you've already cloned the repo without its submodule, + then run this command from the root of the repository: - ```bash - git submodule update --init --recursive - ``` + ```console + git submodule update --init --recursive + ``` -> **Note:** At any time during development +> [!NOTE] +> At any time during development > you can use the `git submodule` command to refresh submodules: > -> ```bash -> git pull; git submodule update --init --recursive +> ```console +> git pull && git submodule update --init --recursive > ``` -## Creating and/or editing DartPad example code +[cloning]: https://docs.github.com/repositories/creating-and-managing-repositories/cloning-a-repository +[forking]: https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo -Most of the code used to create [DartPad][] examples is hosted on GitHub. -However, this repo also contains some `*.dart` files -responsible for DartPad example code. +## Set up your local environment and serve changes -[DartPad]: https://dartpad.dev +Before you continue setting up the site infrastructure, +verify the correct versions of Flutter and Node.js are set up and available by +following the instructions in [Get the prerequisites](#get-the-prerequisites). -### DartPad example code in GitHub gists +1. _Optional:_ After cloning the repo and its submodules, + create a branch for your changes: -A typical DartPad example takes the form of an `iframe`, -for example, within a codelab's Markdown file: + ```console + git checkout -b + ``` -```html - -``` +2. From the root directory of the repository, + fetch the site's Dart dependencies. + + ```console + dart pub get + ``` + +3. Install [`pnpm`][] using your preferred [installation method][pnpm-install]. + `pnpm` is an alternative, efficient package manager for npm packages. + If you already have `pnpm`, verify you have the latest stable version. + We recommend using [`corepack`][] to install and manage `pnpm` versions, + since it is bundled with most installations of Node. + + If you haven't used `corepack` before, you'll need to + first enable it with `corepack enable`. + Then, to install the correct `pnpm` version, from the + root directory of the repository, run `corepack install`: + + ```console + corepack enable + corepack install + ``` -This `iframe` depends on the following GitHub gist URL: -> https://gist.github.com/d7b09149ffee2f0535bb0c04d96987f5 +4. Once you have `pnpm` installed and setup, + fetch the site's npm dependencies using `pnpm install`. + We highly recommend you use `pnpm`, but you can also use `npm`. -For detailed instructions on how to use this approach -to DartPad examples, see the [DartPad embedding guide][]. + ```console + pnpm install + ``` -[DartPad embedding guide]: https://github.com/dart-lang/dart-pad/wiki/Embedding-Guide - +5. From the root directory, run the `dash_site` tool to + validate your setup and learn about the available commands. -## Refreshing code excerpts + ```console + ./dash_site --help + ``` + +6. From the root directory, serve the site locally. + + ```console + ./dash_site serve + ``` + + This command generates and serves the site on a + local port that's printed to your terminal. + +7. View your changes in the browser by navigating to . + + Note the port might be different if `4000` is taken. + + If you want to check the raw, generated HTML output and structure, + view the `_site` directory in a file explorer or an IDE. + +8. Make your changes to the local repo. + + The site should automatically rebuild on most changes, but if + something doesn't update, exit the process and rerun the command. + Improvements to this functionality are planned. + Please open a new issue to track the issue if this occurs. + +9. Commit your changes to the branch and submit your PR. + + If your change is large, or you'd like to test it, + consider [validating your changes](#validate-your-changes). + +> [!TIP] +> To find additional commands that you can run, +> run `./dash_site --help` from the repository's root directory. + +[`corepack`]: https://nodejs.org/api/corepack.html +[`pnpm`]: https://pnpm.io/ +[pnpm-install]: https://pnpm.io/installation + +## Validate your changes + +### Check documentation and example code + +If you've made changes to the code in the `/examples` or `/tool` directories, +commit your work, then run the following command to +verify it is up to date and matches the site standards. + +```console +./dash_site check-all +``` + +If this script reports any errors or warnings, +then address those issues and rerun the command. +If you have any issues, leave a comment on your issue or pull request, +and we'll try our best to help you. +You can also chat with us on the `#hackers-devrel` channel +on the [Flutter contributors Discord][]! + +[Flutter contributors Discord]: https://github.com/flutter/flutter/wiki/Chat + +### Refresh code excerpts A build that fails with the error `Error: Some code excerpts needed to be updated!` means that one or more code excerpts in the markdown file aren't identical to the -code in the corresponding `.dart` file. +code in the corresponding `.dart` file. To resolve this error, from the root of the `website` directory, -run `dart run flutter_site refresh-excerpts`. +run `./dash_site refresh-excerpts`. -For more information see [Code excerpts][] . +For more information see [Code excerpts][] . [Code excerpts]: https://github.com/dart-lang/site-shared/blob/main/doc/code-excerpts.md -## Writing for flutter.dev +## [Optional] Deploy to a staging site + +Submitted pull requests can be automatically staged +by a site maintainer. +If you'd like to stage the site yourself though, +you can build a full version and upload it to Firebase. + +1. If you don't already have a Firebase project, + + - Navigate to the [Firebase Console](https://console.firebase.google.com) + and create your own Firebase project (for example, `flutter-dev-staging`). + + - Head back to your local terminal and verify that you are logged in. + + ```console + firebase login + ``` + + - Ensure that your project exists and activate that project: + + ```console + firebase projects:list + firebase use + ``` + +2. From the root directory of the repository, build the site: + + ```console + ./dash_site build + ``` -The [site-shared](https://github.com/dart-lang/site-shared) repo -contains infrastructure shared by most of our Dart and Flutter websites. -Some of this README is in the -[doc](https://github.com/dart-lang/site-shared/tree/main/doc) -directory in the site-shared repo. + This will build the site and copy it to your local `_site` directory. + If that directory previously existed, it will be replaced. -For more information on using and writing for this repo, -refer to the following docs: +3. Deploy to your activated Firebase project's default hosting site: -* [Writing for Dart and Flutter websites](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md) -* [Infrastructure](https://github.com/dart-lang/site-shared/blob/main/doc/infrastructure.md) -* [Markdown](https://github.com/dart-lang/site-shared/blob/main/doc/markdown.md) -* [Examples](https://github.com/dart-lang/site-shared/blob/main/doc/examples.md) -* [Code excerpts][] -* [Images](https://github.com/dart-lang/site-shared/blob/main/doc/images.md) -* [Mobile friendly pages: tips & tricks](https://github.com/dart-lang/site-shared/blob/main/doc/mobile-friendly-pages.md) + ```console + firebase deploy --only hosting + ``` +4. Navigate to your PR on GitHub and include the link of the staged version. + Do consider adding a reference to the commit you staged, + so that reviewers know if any further changes have been made. diff --git a/_config.yml b/_config.yml deleted file mode 100644 index 0881e0b24f..0000000000 --- a/_config.yml +++ /dev/null @@ -1,252 +0,0 @@ -title: Flutter -url: https://docs.flutter.dev -main-url: https://flutter.dev -email: flutter-dev@googlegroups.com - -google_analytics_id: UA-67589403-1 -google_site_verification: HFqxhSbf9YA_0rBglNLzDiWnrHiK_w4cqDh2YD2GEY4 -google_tag_manager_id: GTM-ND4LWWZ -default_share_image: /assets/images/flutter-logo-sharing.png - - -github_username: flutter -branch: main -repo: - organization: https://github.com/flutter - this: https://github.com/flutter/website - flutter: https://github.com/flutter/flutter - samples: https://github.com/flutter/samples - packages: https://github.com/flutter/packages - gallery-archive: https://github.com/flutter/gallery - engine: https://github.com/flutter/engine - uxr: https://github.com/flutter/uxr - wonderous: https://github.com/gskinnerTeam/flutter-wonderous-app -dart: - api: https://api.dart.dev - sdk: - channel: stable -sdk: - channel: stable # When changing this value also update it in src/_assets/js/archive.js -social: - twitter: https://twitter.com/FlutterDev - youtube: https://www.youtube.com/@flutterdev -dart-site: https://dart.dev -news: https://news.dartlang.org -api: https://api.flutter.dev -main-api: https://main-api.flutter.dev -pub: https://pub.dev -pub-api: https://pub.dev/documentation -pub-pkg: https://pub.dev/packages -flutter-medium: https://medium.com/flutter -medium: https://medium.com -dartpad: https://dartpad.dev -gallery-archive: https://flutter-gallery-archive.web.app -material: https://m3.material.io -material2: https://m2.material.io -so: https://stackoverflow.com -github: https://github.com -flutter-assets: https://flutter.github.io/assets-for-api-docs/assets -android-dev: https://developer.android.com -apple-dev: https://developer.apple.com -google-blog: https://developers.googleblog.com -developers: https://developers.google.com -codelabs: https://codelabs.developers.google.com -groups: https://groups.google.com -firebase: https://firebase.google.com -wonderous: https://wonderous.app/ -youtube-site: https://youtube.com - -yt: - set: 'frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen loading="lazy"' - set-short: 'frameborder="0" allowfullscreen loading="lazy"' - watch: 'https://www.youtube.com/watch' - embed: 'https://www.youtube.com/embed' - playlist: 'https://www.youtube.com/playlist?list=' - -## Software minimum versions - -appmin: - git_win: 2.27 - git_mac: 2.27 - vscode: 1.77 - android_studio: '2023.1 (Hedgehog)' - intellij_idea: '2023.1' - android_sdk: 21 - powershell: 5.0 - xcode: '14' - ios: '17' - cocoapods: '1.10' -devmin: - windows: '64-bit version of Microsoft Windows 10' - macos: '10.15 (Catalina)' - linux: - debian: 11 - ubuntu: '20.04 LTS' -targetmin: - windows: 'Microsoft Windows 7' - macos: '10.14 (Ventura)' - linux: - debian: 10 - ubuntu: '18.04 LTS' - ios: 12 - android: 'Android API level 21' - -## Software current versions - -appnow: - flutter: '3.19.3' - vscode: '1.86' - android_studio: '2023.1 (Hedgehog) or later' - android_sdk: '34.0.0' - intellij: '2023.3' - powershell: 5.1 - xcode: '15' - ios: '17' - cocoapods: '1.13' - -########### Jekyll ########### - -source: src -strict_front_matter: true -permalink: pretty -exclude: [] -liquid: - error_mode: strict - strict_filters: true -sass: - sass_dir: _sass - cache: false - style: compressed - load_paths: - - ../node_modules - -plugins: - - jekyll-toc - -toc: - min_level: 2 - max_level: 3 - -defaults: - - scope: - path: assets/images - values: - image: true - - scope: - path: assets/js - values: - js: true - - scope: - path: '' - values: - layout: default - show-nav-get-started-button: true - show_banner: true - show_footer: true - - scope: - path: '' - values: - toc: true - - scope: - path: 'accessibility-and-localization' - values: - show_breadcrumbs: true - - scope: - path: 'add-to-app' - values: - show_breadcrumbs: true - - scope: - path: 'cookbook' - values: - show_breadcrumbs: true - - scope: - path: 'data-and-backend' - values: - show_breadcrumbs: true - - scope: - path: 'deployment' - values: - show_breadcrumbs: true - - scope: - path: 'get-started' - values: - show_breadcrumbs: true - - scope: - path: 'get-started/flutter-for' - values: - show_breadcrumbs: false - - scope: - path: 'packages-and-plugins' - values: - show_breadcrumbs: true - - scope: - path: 'perf' - values: - show_breadcrumbs: true - - scope: - path: 'platform-integration' - values: - show_breadcrumbs: true - - scope: - path: 'release' - values: - show_breadcrumbs: true - - scope: - path: 'testing' - values: - show_breadcrumbs: true - - scope: - path: 'tools' - values: - show_breadcrumbs: true - - scope: - path: 'ui' - values: - show_breadcrumbs: true - - scope: - path: 'ui/widgets' - values: - toc: false - - -########### Alerts ########### -# TODO these are bootstrap related, will not be supported - -alert: - bonus: >- -