Merge pull request #1270 from hydephp/format-markdown-documents

caendesilva · web-flow · commit b9ddcd545a27 · 2023-03-13T22:40:56.000+01:00
Format Markdown documents
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,11 +4,13 @@ Contributions are **welcome** and will be fully **credited**.
 
 Please read and understand the contribution guide before creating an issue or pull request. This document is a living standard that may be updated when needed.
 
+
 ## Resources
 
 If you're new to HydePHP and are looking to contribute, it may be helpful to learn how the ecosystem and core development works.
 It's thus highly advised you visit our [Developer Resources](https://hydephp.com/community) to learn how HydePHP is structured.
 
+
 ## Etiquette
 
 This project is open source, and as such, the maintainers give their free time to build and maintain the source code
@@ -21,6 +23,7 @@ world that developers are civilized and selfless people.
 It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
 quality to benefit the project. Many developers have different skill sets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
 
+
 ## Viability
 
 When requesting or submitting new features, first consider whether they might be useful to others. Open
@@ -51,13 +54,15 @@ Before submitting a pull request:
 - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
 - Check the feature is a viable for the project (see above)
 
+
 ## How-to
 
 HydePHP development is made in the HydePHP monorepo found at https://github.com/hydephp/develop.
 To get started, you will need to clone the repository, and run `composer install`. You will then be able to make changes to the packages found in the `packages/` sub-directories.
 
 Once you've made and commited your changes, submit a pull request to the same repository, and explain your changes and how they improve the codebase.
 
+
 ## Requirements
 
 If the project maintainer has any additional requirements, you will find them listed here.
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@
 
 > This repository holds the source code for the HydePHP core components. If you want to create a website with Hyde, check out the [HydePHP/Hyde repository](https://github.com/hydephp/hyde).
 
+
 ## Projects in this monorepo
 
 [![Upcoming Documentation](https://img.shields.io/badge/-Upcoming%20Documentation-525252)](https://hydephp.github.io/develop/master/dev-docs/)
@@ -55,15 +56,12 @@ The two most important components are **Hyde** and **Framework**. We also use **
 | **UI Kit**            | [packages/ui-kit](packages/ui-kit)                       | [hydephp/ui-kit](https://github.com/hydephp/ui-kit)                       | [hyde/ui-kit](https://packagist.org/packages/hyde/ui-kit)                       |
 | **HydeFront**         | [packages/hydefront](packages/hydefront)                 | [hydephp/hydefront](https://github.com/hydephp/hydefront)                 | [npm@hydefront](https://www.npmjs.com/package/hydefront)                        |
 
-
 *The Hyde/Hyde project is stored in the monorepo root and works a bit differently from the others. Before pushing to the readonly repository, we apply persisted changes in the [`packages/hyde`](https://github.com/hydephp/develop/tree/master/packages/hyde) directory, then remove monorepo specific files.
 
-
 ### How the monorepo works
 
 Changes to HydePHP including some first-party packages are made here. The changes are then pushed to the `develop` or `master` branches of the readonly repositories seen in the table above.
 
-
 ### Releases
 
 The versioning between the Framework and Hyde packages are linked together Meaning that if Hyde get's a major release, so must Framework, and vice versa. To make this easier, we also publish major and minor releases in the monorepo. Patch releases are not published in the monorepo, and are instead handled by the individual packages.
diff --git a/packages/framework/README.md b/packages/framework/README.md
@@ -8,7 +8,9 @@
 [![Test Coverage](https://codecov.io/gh/hydephp/develop/branch/master/graph/badge.svg?token=G6N2161TOT)](https://codecov.io/gh/hydephp/develop)
 [![Test Suite](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml)
 
+
 ## About
+
 HydePHP is a content-first Laravel-powered Static Site Builder that allows you to create static HTML pages, blog posts, and documentation sites using Markdown.
 Hyde is all about letting you get started quickly by giving you a full-featured frontend starter kit, while also giving you the power and freedom of doing things the way you want to.
 
diff --git a/packages/framework/SECURITY.md b/packages/framework/SECURITY.md
@@ -12,13 +12,6 @@ These are the version ranges of HydePHP, and their support status. We follow [Se
 | < 0.8   | :x:                | Alpha stage          |
 
 
-<!-- 
-| 5.1.x   | :white_check_mark: |
-| 5.0.x   | :x:                |
-| 4.0.x   | :white_check_mark: |
-| < 4.0   | :x:                | -->
-
-
 ## Reporting a Vulnerability
 
 If you discover a security vulnerability within this package, please send an e-mail to the creator, Caen De Silva, via caen@desilva.se.
diff --git a/packages/framework/tests/README.md b/packages/framework/tests/README.md
@@ -1,3 +1,3 @@
 # Hyde Testing
 
-The tests here cover the Hyde/Framework package. Note that they are intended to be run through the monorepo.
+The tests here cover the Hyde/Framework package. Note that they are intended to be run through the monorepo.
diff --git a/packages/hyde/README.md b/packages/hyde/README.md
@@ -1,6 +1,5 @@
 # HydePHP - Elegant and Powerful Static Site Generator
 
-
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/hyde/framework?include_prereleases)](https://packagist.org/packages/hyde/framework)
 [![Total Downloads on Packagist](https://img.shields.io/packagist/dt/hyde/framework)](https://packagist.org/packages/hyde/framework)
 [![License MIT](https://img.shields.io/github/license/hydephp/hyde) ](https://github.com/hydephp/hyde/blob/master/LICENSE.md)
@@ -11,12 +10,14 @@
 ## Make static websites, blogs, and documentation pages with the tools you already know and love.
 
 ### About HydePHP
+
 HydePHP is a content-first Laravel-powered console application that allows you to create static HTML pages, blog posts, and documentation sites,
 using your choice of Markdown and/or Blade.
 
 Build sites in record-time with a full batteries-included TailwindCSS frontend that just works without any fuzz.
 
 ### Speed & simplicity first, full control when you need it.
+
 Hyde is all about letting you get started quickly by giving you a full-featured frontend starter kit, while also giving you the power and freedom of doing things the way you want to.
 
 Markdown purist? That's all you need. Blade artisan? Go for it.
@@ -25,35 +26,42 @@ You don't _need_ to customize anything. But you _can_ customize everything.
 
 See the documentation and learn more at https://hydephp.com/docs/
 
+
 ## Features
 
 ### Content Creation
+
 - Create blog posts using Markdown and Front Matter.
 - Create documentation pages from plain Markdown, no front matter needed!
 - Create simple pages using Markdown, or create advanced ones using Laravel Blade.
 - You can scaffold blog posts and Markdown pages to automatically fill in the front matter.
 - You can also scaffold Blade pages to automatically use the default layout.
 
 ### Built-in Frontend
+
 - Hyde comes with a TailwindCSS starter kit so you can start making content right away.
 - The starter kit is fully responsive, has a dark mode theme, and is customizable.
 - The frontend is accessible to screenreaders and rich with semantic HTML and microdata.
 - Hyde automatically chooses the right layout to use depending on the content being rendered.
 - Hyde also fills in and creates content like navigation menus and sidebars automatically.
 
 ### Easy Asset Managing
+
 - The Hyde starter comes with [HydeFront](https://github.com/hydephp/hydefront/) to serve the base stylesheet and JavaScript through the jsDelivr CDN.
 - Hyde ships with precompiled and minified TailwindCSS styles in the app.css file, you can also load them through the CDN.
 - This means that all the styles you need are already installed. However, if you want to customize the Tailwind config, or if you add new Tailwind classes through Blade files, you can simply run the `npm run dev` command to recompile the styles using Laravel Mix.
 
 ### Customization
+
 - You don't need to configure anything as Hyde is shipped with sensible defaults.
 - You can, however, customize nearly everything. Here are some examples:
 - All frontend components and page layouts are created with Blade so you
   can publish the vendor views, just like in Laravel.
 - Override many of the dynamic content features like the menus and footer.
 
+
 ## Getting Started - High-level overview
+
 > See [Installation Guide](https://hydephp.com/docs/master/installation.html) and [Getting Started](https://hydephp.com/docs/master/getting-started.html) for the full details.
 
 It's a breeze to get started with Hyde. Create a new Hyde project using Composer:
@@ -70,6 +78,7 @@ When you're ready, run the build command to compile your static site which will
 php hyde build
 ```
 
+
 ## Resources
 
 ### Changelog
@@ -97,6 +106,7 @@ All vulnerabilities will be promptly addressed.
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
 
 ### Attributions
+
 > Please see the respective authors' repositories for their license files
 
 - The Hyde core is built with [Laravel Zero](https://laravel-zero.com/) which is based on [Laravel](https://laravel.com/)
diff --git a/packages/hydefront/README.md b/packages/hydefront/README.md
@@ -4,6 +4,7 @@
 ![NPM Downloads](https://img.shields.io/npm/dm/hydefront)
 [![Build & Push CI](https://github.com/hydephp/hydefront/actions/workflows/node.js.yml/badge.svg)](https://github.com/hydephp/hydefront/actions/workflows/node.js.yml)
 
+
 ## About this repository
 
 Contains the frontend assets for HydePHP.
@@ -18,14 +19,19 @@ Normally, this file is imported into the main.css file.
 - **App.css**:
 A compiled and minified file containing the TailwindCSS styles for a base Hyde installation. It includes the Hyde.css file. This file is identical to what one would get by running `npm run prod` in a new HydePHP project (which incidentally is exactly how this file is generated).
 
+
 ## Usage
 
 HydeFront is included with [HydePHP](https://github.com/hydephp/hyde) by default.
 
+
 ## Links:
+
 - GitHub https://github.com/hydephp/hydefront
 - NPM https://www.npmjs.com/package/hydefront
 - jsDelivr https://www.jsdelivr.com/package/npm/hydefront
 
+
 ## Warranty:
+
 HydeFront is not intended to be used for standalone projects and comes with no warranties. Changes in HydeFront are tied to those in the Hyde Framework and differing versions may be incompatible.
diff --git a/packages/realtime-compiler/README.md b/packages/realtime-compiler/README.md
@@ -4,6 +4,7 @@ The source code for the HydePHP Realtime Compiler/Server. This package is includ
 
 The package adds a `php hyde serve` command which exposes a web server on port `8080` which will compile the requested web page on the fly and serve it to the browser.
 
+
 ## Supported Versions
 
 This package is not intended to be used outside the HydePHP framework.
diff --git a/packages/realtime-compiler/SECURITY.md b/packages/realtime-compiler/SECURITY.md
@@ -2,7 +2,6 @@
 
 ## Reporting a Vulnerability
 
-
 If you discover a security vulnerability within this package, please send an e-mail to the creator, Caen De Silva, via caen@desilva.se.
 
 All security vulnerabilities will be promptly addressed.
diff --git a/packages/testing/LICENSE.md b/packages/testing/LICENSE.md
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.
diff --git a/packages/testing/README.md b/packages/testing/README.md
@@ -3,9 +3,9 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/hyde/testing.svg?style=flat-square)](https://packagist.org/packages/hyde/testing)
 [![Total Downloads](https://img.shields.io/packagist/dt/hyde/testing.svg?style=flat-square)](https://packagist.org/packages/hyde/testing)
 
-
 Warning: This package should only be used as a dev-dependency, and never in production.
 
+
 ## Installation
 
 You can install the package via composer:
@@ -14,6 +14,7 @@ You can install the package via composer:
 composer require hyde/testing --dev
 ```
 
+
 ## Usage
 
 This package is created for and intended to be used specifically with HydePHP. It will likely not work with other frameworks, and such usage is discouraged.
@@ -22,6 +23,7 @@ This package is created for and intended to be used specifically with HydePHP. I
 php hyde test
 ```
 
+
 ## Contributing
 
 Please see the [hydephp/develop](https://github.com/hydephp/develop/issues) monorepo for details.
@@ -32,6 +34,7 @@ If you discover any security related issues, please email caen@desilva.se instea
 
 There are no backwards compatibility guarantees other than what is implicitly offered through the HydePHP packages requiring this package.
 
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
diff --git a/packages/ui-kit/LICENSE.md b/packages/ui-kit/LICENSE.md
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.
diff --git a/packages/ui-kit/README.md b/packages/ui-kit/README.md
@@ -3,19 +3,22 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/hyde/ui-kit.svg?style=flat-square)](https://packagist.org/packages/hyde/ui-kit)
 [![Total Downloads](https://img.shields.io/packagist/dt/hyde/ui-kit.svg?style=flat-square)](https://packagist.org/packages/hyde/ui-kit)
 
+
 ## About
 
 The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCSS components for Laravel Blade,
 indented to be used with HydePHP. Note that these components may require CSS classes not present in the bundled app.css
 file and that you may need to recompile the CSS file using the included Laravel Mix configuration.
 
+
 ## Warning
 
 The HydePHP UI Kit is still in development and is not yet ready for production use.
 All components including their names can and probably will be changed.
 
 Versions in the 0.x range are considered unstable and may contain breaking changes.
 
+
 ## Installation
 
 You can install the package via composer:
@@ -26,6 +29,7 @@ composer require hyde/ui-kit
 
 Since HydePHP already comes with several built-in views and templates, including a precompiled CSS file to get you started quickly, this package is not required to use HydePHP and is tailored to intermediate-to-advanced users, giving you an excellent productivity boost in kick-starting development of any custom Blade pages.
 
+
 ## Usage
 
 Once installed, the package service provider will automatically register the Blade components for you to use.
@@ -35,6 +39,7 @@ You might also need to recompile the CSS file using the Laravel Mix configuratio
 
 You can see a list of all available components in the [documentation](https://hydephp.github.io/ui-kit/).
 
+
 ## Contributing
 
 Please see the [hydephp/develop](https://github.com/hydephp/develop/issues) monorepo for details.
@@ -45,6 +50,7 @@ If you discover any security related issues, please email caen@desilva.se instea
 
 There are no backwards compatibility guarantees other than what is implicitly offered through the HydePHP packages requiring this package.
 
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
diff --git a/packages/ui-kit/docs/documentation.md b/packages/ui-kit/docs/documentation.md
@@ -4,17 +4,20 @@ The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCS
 indented to be used with HydePHP. Note that these components may require CSS classes not present in the bundled app.css
 file and that you may need to recompile the CSS file using the included Laravel Mix configuration.
 
+
 ## Warning
 
 The HydePHP UI Kit is still in development and is not yet ready for production use.
 All components including their names can and probably will be changed.
 
+
 ## Preface
 
 Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.
 
 >info Tip: Most components allow you to pass any additional HTML attributes to the element!
 
+
 ## Components
 
 ### Buttons
@@ -120,7 +123,7 @@ This component will convert any Markdown within it to HTML using the Hyde Markdo
 ```blade
 <x-hyde-ui::markdown>
     ## Markdown Heading
-    
+
     Hello world!
 </x-hyde-ui::markdown>
 ```

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# Hyde Testing`
`2`	`2`
`3`		`-The tests here cover the Hyde/Framework package. Note that they are intended to be run through the monorepo.`
	`3`	`+The tests here cover the Hyde/Framework package. Note that they are intended to be run through the monorepo.`