From 31d5eb57c342bfced971127b0268d07651bd825b Mon Sep 17 00:00:00 2001 From: Brandy Carney <6577830+brandyscarney@users.noreply.github.com> Date: Fri, 27 Dec 2024 17:46:17 -0500 Subject: [PATCH] docs(glossary): update formatting to remove line breaks around links --- .prettierignore | 1 + docs/reference/glossary.md | 253 ++++++++++++------------------------- 2 files changed, 82 insertions(+), 172 deletions(-) diff --git a/.prettierignore b/.prettierignore index 70428587de1..e523352d6cd 100644 --- a/.prettierignore +++ b/.prettierignore @@ -7,6 +7,7 @@ docs/api docs/native versioned_docs/version-v*/native docs/cli/commands +docs/reference/glossary.md static/code/stackblitz diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index 110d5514beb..a79eed60cc4 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -17,12 +17,7 @@ title: Glossary
- - Accessibility - {' '} - (a11y) is the practice of enabling as many people as possible to use the content, even if people have limited - abilities. This includes people with disabilities, those using mobile devices, and those with slow network - connections. Content should be developed to be as accessible as technology allows. + Accessibility (a11y) is the practice of enabling as many people as possible to use the content, even if people have limited abilities. This include people with disabilities, those using mobile devices, and those with slow network connections. Content should be developed to be as accessible as technology allows.
@@ -31,12 +26,7 @@ title: Glossary- The{' '} - - Android SDK - {' '} - is a software development kit built for developers building for Google's Android Platform. It includes tools for - building, testing, and debugging Android applications. + The Android SDK is a software development kit built for developers building for Google's Android Platform. It includes tools for building, testing, and debugging Android applications.
@@ -45,10 +35,8 @@ title: Glossary- - Android Studio - {' '} - is the official Integrated Development Environment (IDE) for Native Android app development. + Android Studio is the official + Integrated Development Environment (IDE) for Native Android app development.
@@ -57,10 +45,8 @@ title: Glossary
-
- Autoprefixer
- {' '}
- is a tool that adds vendor-specific-prefixes to hand-written Sass/CSS code. This ensures that standardized CSS rules
+ Autoprefixer is a tool that adds
+ vendor-specific-prefixes to hand-written Sass/CSS code. This ensures that standardized CSS rules
you write will be applied across all supporting browsers. For example, instead of having to know every flexbox
syntax used by various browsers, autoprefixer allows you to just write display: flex;
and it'll
automatically plug in the correct CSS.
@@ -82,13 +68,10 @@ title: Glossary
- - Capacitor - {' '} - is an open source cross-platform app runtime that allows web-based apps to run natively on iOS, Android, Electron, - and the web. It's helpful to refer to these apps "Native Progressive Web Apps" and they represent the next evolution - beyond the traditional Hybrid app mentality. Capacitor was created and is actively developed/supported by Ionic, the - company. + Capacitor is an open source cross-platform app runtime + that allows web-based apps to run natively on iOS, Android, Electron, and the web. It's helpful to refer to these + apps "Native Progressive Web Apps" and they represent the next evolution beyond the traditional Hybrid app mentality. + Capacitor was created and is actively developed/supported by Ionic, the company.
@@ -101,13 +84,10 @@ title: GlossaryA CLI, or Command-Line Interface, is a text-based interface for interacting with a program. The common command-line app for a Mac user is the Terminal app, and Windows users often - use Command Prompt. The Ionic community often uses this term to refer to{' '} + use Command Prompt. The Ionic community often uses this term to refer to Ionic's CLI. Ionic's CLI can be used for a number of things, such - as creating production builds of an app, running the development server, and accessing{' '} - - Ionic commercial services - - . + as creating production builds of an app, running the development server, and accessing + Ionic commercial services.
@@ -118,11 +98,8 @@ title: Glossary- - CommonJS - {' '} - is a group that defines standard formats for JavaScript APIs. They have defined standards for JavaScript modules and - packages. + CommonJS is a group that defines + standard formats for JavaScript APIs. They have defined standards for JavaScript modules and packages.
@@ -131,12 +108,10 @@ title: Glossary- - Apache Cordova - {' '} - is an open source mobile application development framework that transforms standard HTML/CSS/JS into full-fledged - native apps. It provides a JavaScript API for accessing native device functionality, such as the camera or - accelerometer. Cordova contains the necessary build tools for packaging webapps for iOS, Android, and Windows Phone. + Apache Cordova is an open source mobile application + development framework that transforms standard HTML/CSS/JS into full-fledged native apps. It provides a JavaScript + API for accessing native device functionality, such as the camera or accelerometer. Cordova contains the necessary + build tools for packaging webapps for iOS, Android, and Windows Phone.
@@ -145,10 +120,8 @@ title: Glossary- - CORS - {' '} - (Cross-Origin Resource Sharing) is a mechanism for servers to control client access to web assets. See the{' '} + CORS + (Cross-Origin Resource Sharing) is a mechanism for servers to control client access to web assets. See the CORS FAQs for more information.
@@ -158,10 +131,8 @@ title: Glossary- You may be familiar with variables from Sass.{' '} - - CSS Variables - {' '} + You may be familiar with variables from Sass. + CSS Variables enable the same functionality but are built into the browser. CSS Variables are available in all evergreen browsers.
@@ -172,7 +143,7 @@ title: GlossaryDecorators are expressions that return a function. They allow you to take an existing function, and extend its - behavior. With TypeScript, you can also decorate classes and parameters. When you decorate a{' '} + behavior. With TypeScript, you can also decorate classes and parameters. When you decorate a class, you are wrapping and extending the behavior of its constructor. In other words, the decorator will add some functionality when the constructor is called, and will then return the original constructor. When you decorate a parameter, you are wrapping the argument that gets passed in for that @@ -240,11 +211,8 @@ title: Glossary
- - Git - {' '} - is a distributed version control system for managing code. It allows development teams to contribute code to the - same project without causing code conflicts. + Git is a distributed version control system for managing code. + It allows development teams to contribute code to the same project without causing code conflicts.
@@ -253,12 +221,9 @@ title: Glossary- - Gulp - {' '} - is a tool for running tasks which can be used to build your app. Common build tasks include transpiling{' '} - ES6 to ES5, turning Sass into CSS, minifying code, - and concatenating files. + Gulp is a tool for running tasks which can be used to build your app. + Common build tasks include transpiling ES6 to ES5, turning + Sass into CSS, minifying code, and concatenating files.
@@ -267,9 +232,7 @@ title: Glossary- - ES Modules - {' '} + ES Modules brings the concept of modules natively to JavaScript. With modules, classes and variables are no longer in the global scope and have to be explicitly imported into your project to be used. This makes it much easier to understand where your code is coming from and increases modularity and compartmentalization of functionality. @@ -281,12 +244,9 @@ title: Glossary
- - Ionicons - {' '} - is an open-source icon set used and created by Ionic. It includes 1:1 iOS and Material Design icons, as well as - commonly used social/application icons. Ionicons is included by default in Ionic distributions, but they can also be - used in any project. + Ionicons is an open-source icon set used and created + by Ionic. It includes 1:1 iOS and Material Design icons, as well as commonly used social/application icons. + Ionicons is included by default in Ionic distributions, but they can also be used in any project.
@@ -295,11 +255,9 @@ title: Glossary- - Karma - {' '} - is a test runner that will run an app's test inside a real browser. It executes test cases, written in any testing - framework, in a real browser. Karma was originally written for use with Angular 1. + Karma is a test runner that + will run an app's test inside a real browser. It executes test cases, written in any testing framework, in + a real browser. Karma was originally written for use with Angular 1.
@@ -328,9 +286,9 @@ title: Glossary- Live Reload (or live-reload) is a tool that automatically reloads the browser or{' '} + Live Reload (or live-reload) is a tool that automatically reloads the browser or Web View when it detects changes in your app. In some cases, it can replace - parts of your app without having to reload the entire window. See the{' '} + parts of your app without having to reload the entire window. See the Live Reload docs for more information.
@@ -340,11 +298,9 @@ title: Glossary- - Node - {' '} - is a runtime environment that allows JavaScript to be written on the server-side. In addition to being used for web - services, node is often used to build developer tools, such as the Ionic CLI. + Node is a runtime environment that allows JavaScript to be + written on the server-side. In addition to being used for web services, node is often used to build developer + tools, such as the Ionic CLI.
@@ -353,11 +309,9 @@ title: Glossary- - npm - {' '} - is the package manager for node. It allows developers to install, share, and package node - modules. Ionic can be installed with npm, along with a number of its dependencies. + npm is the package manager for node. + It allows developers to install, share, and package node modules. Ionic can be installed with npm, along with + a number of its dependencies.
@@ -377,13 +331,9 @@ title: Glossary- Referred to by Apple as Bundle ID and by Android as Application ID, the{' '} + Referred to by Apple as Bundle ID and by Android as Application ID, the Package ID is used for identifying apps published to the App Store/Play Store. It is a string - formatted in{' '} - - reverse-DNS notation - - . + formatted in reverse-DNS notation.
@@ -392,12 +342,9 @@ title: Glossary- A{' '} - - polyfill - {' '} - is a bit of code that adds functionality to the browser and normalizes browser differences. This is similar to a{' '} - shim, but where a shim has it's own API, a polyfill let's the expect API of the browser be used. + A polyfill is a bit of code that + adds functionality to the browser and normalizes browser differences. This is similar to a shim, + but where a shim has it's own API, a polyfill let's the expect API of the browser be used.
@@ -406,11 +353,9 @@ title: Glossary- - Protractor - {' '} - is a testing framework written for and by the Angular team. Protractor can be used with test runners, like Karma, - for end-to-end testing. Test runners allow you to quickly and programmatically verify code quality. + Protractor is a testing framework written for + and by the Angular team. Protractor can be used with test runners, like Karma, for end-to-end testing. Test runners + allow you to quickly and programmatically verify code quality.
@@ -420,15 +365,9 @@ title: GlossarySass is a stylesheet language that compiles to CSS and is used by Ionic. Sass is like CSS, but with extra features - such as{' '} - - variables - - , - mixins - , and - loops - . + such as variables, + mixins, and + loops.
@@ -438,15 +377,10 @@ title: GlossaryA component that uses scoped encapsulation will automatically scope its CSS by appending each of the styles with a - data attribute at run time. Overriding scoped selectors in CSS requires a{' '} - - higher specificity - {' '} - selector. Scoped components can also be styled using{' '} - - CSS Custom Properties - - . + data attribute at run time. Overriding scoped selectors in CSS requires a + higher specificity + selector. Scoped components can also be styled using + CSS Custom Properties.
@@ -455,19 +389,11 @@ title: Glossary- - Shadow DOM - {' '} + Shadow DOM is a native browser solution for DOM and style encapsulation of a component. It shields the component from its - surrounding environment. To externally style internal elements of a Shadow DOM component you must use{' '} - - CSS Custom Properties - {' '} - or{' '} - - CSS Shadow Parts - - . + surrounding environment. To externally style internal elements of a Shadow DOM component you must use + CSS Custom Properties + or CSS Shadow Parts.
@@ -487,9 +413,9 @@ title: GlossaryTranspilation is the process of converting code from one language to another language prior to execution. Typically, - a transpiler will convert a high-level language to another high-level language. The most common type of{' '} - transpilation in Ionic Framework is converting ES2015/ES6 ( - TypeScript) to ES5 (traditional JavaScript). + a transpiler will convert a high-level language to another high-level language. The most common type of + transpilation in Ionic Framework is converting ES2015/ES6 + (TypeScript) to ES5 (traditional JavaScript).
@@ -498,18 +424,11 @@ title: Glossary- - TypeScript - {' '} - is a superset of JavaScript, which means it gives you JavaScript, along with a number of extra features such as{' '} - - type declarations - {' '} - and{' '} - - interfaces - - . Although Ionic is built with TypeScript, using it to build an Ionic app is completely optional. + TypeScript is a superset of JavaScript, + which means it gives you JavaScript, along with a number of extra features such as + type declarations + and interfaces. + Although Ionic is built with TypeScript, using it to build an Ionic app is completely optional.
@@ -528,12 +447,9 @@ title: Glossary- - Webpack - {' '} - bundles together JavaScript modules and other assets. It can be used to create single or multiple "chunks" that are - only loaded when needed. Webpack can be used to take many files and dependencies and bundle them into one file, or - other types. + Webpack bundles together JavaScript modules and other assets. + It can be used to create single or multiple "chunks" that are only loaded when needed. Webpack can be used to take + many files and dependencies and bundle them into one file, or other types.
@@ -542,15 +458,10 @@ title: Glossary- The{' '} - - World Wide Web Consortium - {' '} - (W3C) is the standards organization for the Web. Together, industry leaders and the public work together to develop{' '} - - web standards - - , which are a set of protocols, specifications, and technologies that define the Web Platform. + The World Wide Web Consortium (W3C) is the standards organization + for the Web. Together, industry leaders and the public work together to develop + web standards, which are a set of protocols, specifications, + and technologies that define the Web Platform.
@@ -559,11 +470,9 @@ title: Glossary- - Xcode - {' '} - is an Apple IDE (integrated development environment) for software development on Apple operating systems (macOS, - iOS, watchOS and tvOS), with extensions available for other languages and platforms. + Xcode is an Apple IDE (integrated development + environment) for software development on Apple operating systems (macOS, iOS, watchOS and tvOS), with extensions + available for other languages and platforms.