docs: add support to markdownlint

.github/docs/CONTRIBUTING.md

@@ -1,41 +1,40 @@
-## 🤝 Contribution Guide
+# 🤝 Contribution Guide
 
 ## 📋 Topics
+
 - [🤝 Contribution Guide](#-contribution-guide)
-- [📋 Topics](#-topics)
-- [🎯 About](#-about)
-- [🏆 Important details](#-important-details)
-- [🐛 Issues Reporting](#-issues-reporting)
-- [🙏 Thanks](#-thanks)
+  - [📋 Topics](#-topics)
+  - [🎯 About](#-about)
+  - [🏆 Important details](#-important-details)
+  - [🐛 Issues Reporting](#-issues-reporting)
+  - [🙏 Thanks](#-thanks)
 
 ## 🎯 About
 
-Hello, I'm glad to see you're interested in contributing to this project. 
+Hello, I'm glad to see you're interested in contributing to this project.
 
 Some settings you may have already seen in the README.md file, but it doesn't hurt to repeat them here.
 
-**TL;DR:** In a simple and *generic* way, you can contribute in this way below: 
+**TL;DR:** In a simple and *generic* way, you can contribute in this way below:
 
-```
 - Fork this repository;
 - Create a branch with your feature: git checkout -b my-feature;
 - Commit your changes: git commit -m 'feat: My new feature';
 - Push your branch: git push origin my-feature.
 - Make a pull request, describing the changes you made and await approval.
 - You can also make suggestions by opening an issue, reporting bugs or requesting new features.
-```
 
 ## 🏆 Important details
 
-Details make all the difference. Especially for attentive souls. For people who seek excellence. I will not treat this project differently. 
+Details make all the difference. Especially for attentive souls. For people who seek excellence. I will not treat this project differently.
 
-So let's go! 
+So let's go!
 
 I ask you to follow the following steps:
 
 - Use the [Conventional Commits](https://www.conventionalcommits.org/);
 - Use the [GitFlow Workflow](https://www.atlassian.com/br/git/tutorials/comparing-workflows/gitflow-workflow);
-- Follow style guides: 
+- Follow style guides:
   - [Dart Style Guide](https://dart.dev/guides/language/effective-dart/style).
   - [Flutter Style Guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo).
 - Don't forget to follow [flutter_lints](https://pub.dev/packages/flutter_lints) rules.
@@ -52,14 +51,14 @@ I ask you to follow the following steps:
 If you found a bug or have a suggestion, feel free to open an issue. But before doing that, please read the following:
 
 - Check if the issue was not reported, you can see in [Issues](https://github.com/felipecastrosales/site/issues) tab;
-- Provide a clear and consice description of the issue; 
+- Provide a clear and consice description of the issue;
 - Include screenshots or related files;
 - Indicate the expected behavior in comparison to the current behavior;
 - Indicate the steps to reproduce the issue;
 - Give suggestions on how we can solve this, it's always nice to have new ideas.
 
 ## 🙏 Thanks
 
-Just seeing your interest in contributing already got me excited. 
+Just seeing your interest in contributing already got me excited.
 
-Know that even giving a star ⭐️ you will already be collaborating with the project. 
+Know that even giving a star ⭐️ you will already be collaborating with the project.

.github/docs/CONTRIBUTORS.md

@@ -1,4 +1,4 @@
-## 🎖️ Contributors
+# 🎖️ Contributors
 
 This is a special area for contributors.
 

.github/docs/WANTTODO.md

@@ -1,15 +1,17 @@
-## 🤩 Want to do
+# 🤩 Want to do
 
 Before I even openly release officially this to community, I already shared it with a few people, as well as already hosted it; and some of them asked me if they could use the model for their own use. And of course, that's why I'm making a point of explaining better how you can make this project yours.
 
-First, Follow the [🤔 How to Use](#-how-to-use) steps.
+First, Follow the [🤔 How to Use](./README.md#-how-to-use) steps.
+
+## Figma
 
-### Figma
 - See file [here](https://www.figma.com/file/gG2B4ZopeGX2Wt0RTkAxkT/Minha-Identidade?node-id=0-1&t=0s6dYkwbOzUOfxJN-0)
 - Open project, and duplicate it.
 - Change all datas to yours (as images), and export files substituting the originals.
 
 ## Project Datas
+
 - If you want to change the tokens (colors etc), you can do it in the `lib/app/core/tokens/app_colors.dart` file.
 - To change the texts datas:
   - Open `lib/app/core/l10n/templates` and change the `.arb` files to yours - or update the existing ones.
@@ -19,11 +21,13 @@ First, Follow the [🤔 How to Use](#-how-to-use) steps.
   - And finally, comment the `synthetic-package: false` again, inside the [l10n.yaml](l10n.yaml) file.
 
 ## Contact Form
+
 - Related to Contact Form:
   - Create your account inside `emailjs` and make your changes.
   - You can see [this video](https://www.youtube.com/watch?v=9HW3MZ_tsdo), to help you on practice.
 
 ## Firebase
+
 - Create your Firebase project, and make your necessary changes.
 - Configure all, see the [Firebase CLI](https://firebase.flutter.dev/docs/cli/) to help you with productivity.
 
@@ -36,6 +40,6 @@ I put the informations of contact form inside the Remote Config, so create this
 - `user_id`
 - `to_email`
 
-## Others 
+## Others
 
-If you want more information or others specific changes, you can open an issue or contact me. I will be happy to help you. :)
+If you want more information or others specific changes, you can open an issue or contact me. I will be happy to help you.

.markdownlint.json

@@ -0,0 +1,9 @@
+{
+    "MD033": {
+        "allowed_elements": [
+            "a",
+            "sup",
+            "nobr"
+        ]
+    }
+}

README.md

@@ -1,4 +1,4 @@
-<h1 align="center"><a href="https://felipecastrosales.com">My Website 🔥</a></h1>
+<h1 align="center"><a href="https://felipecastrosales.com">My Portfolio 🔥</a></h1>
 
 ---
 
@@ -26,7 +26,7 @@
 
 ## 📋 About
 
-With a single codebase, you can access this example from mobile, web and even desktop. 
+With a single codebase, you can access this example from mobile, web and even desktop.
 
 I'm sure this will be one of the best examples of the Flutter Web project in a completely open-source way and with the amout of features that exist.
 
@@ -47,6 +47,7 @@ TODO: ADD DEMO IN APP (iosSimulator) AND IN WEB
 ---
 
 ## 🚀 Technologies and Tools
+
 - Extremely Responsive Design using [`LayoutBuilder`](https://api.flutter.dev/flutter/widgets/LayoutBuilder-class.html) and other various strategies;
 - Dependency Injection with [`GetIt`](https://pub.dev/packages/get_it);
 - Use of [`scrollable_positioned_list`](https://pub.dev/packages/scrollable_positioned_list) to perform the "scroll to index" feature;
@@ -56,19 +57,19 @@ TODO: ADD DEMO IN APP (iosSimulator) AND IN WEB
   - [`firebase_core`](https://pub.dev/packages/firebase_core);
   - [`firebase_remote_config`](https://pub.dev/packages/firebase_remote_config);
   - [`firebase_core_platform_interface`](https://pub.dev/packages/firebase_core_platform_interface) - for tests.
-- Tests: 
+- Tests:
   - Unitary, Widgets and Integration Test;
   - The current coverage is 79.5% (PRs are welcome to increase this value);
   - All of them using [`mocktail`](https://pub.dev/packages/mocktail).
-- Internationalization: 
+- Internationalization:
   - With support to 3 languages: English, Portuguese and Spanish;
 - Feature to send an email to the user using [`emailjs API`](https://www.emailjs.com/);
 - Settings:
   - Firebase Hosting;
   - Google Domains;
   - Google Analytics;
   - Firebase Remote Config.
-- Use of good practices in general, such as: 
+- Use of good practices in general, such as:
   - [`Clean Code`](https://www.google.com/search?q=Clean+Code+book&rlz=1C5CHFA_enBR1041BR1041&sxsrf=AJOqlzWiUKnodTrErtwjEw0mr60aKlAQ9A%3A1679360561304&ei=MQIZZICZEpDM1sQPqrSdsAI&ved=0ahUKEwjA9dLN6ev9AhUQppUCHSpaByYQ4dUDCA8&uact=5&oq=Clean+Code+book&gs_lcp=Cgxnd3Mtd2l6LXNlcnAQAzIFCC4QgAQyBQgAEIAEMgYIABAHEB4yBggAEAcQHjIGCAAQBxAeMgYIABAHEB4yBggAEAcQHjIICAAQBxAeEAoyBggAEAcQHjIGCAAQBxAeOgoIABBHENYEELADOgcIABCwAxBDOg0IABDkAhDWBBCwAxgBOgwILhDIAxCwAxBDGAJKBAhBGABQnQZYnQZg7wdoAXABeACAAaMBiAGjAZIBAzAuMZgBAKABAqABAcgBEcABAdoBBggBEAEYCdoBBggCEAEYCA&sclient=gws-wiz-serp);
   - [`Clean Architecture`](https://www.google.com/search?q=Clean+Architecture+book&rlz=1C5CHFA_enBR1041BR1041&sxsrf=AJOqlzWTbx1VkaRMx9Y0pkUmhUFVrdPbew%3A1679360551842&ei=JwIZZKnyMuLf1sQP0-y2MA&ved=0ahUKEwjpoZHJ6ev9AhXir5UCHVO2DQYQ4dUDCA8&uact=5&oq=Clean+Architecture+book&gs_lcp=Cgxnd3Mtd2l6LXNlcnAQAzIFCC4QgAQyCAgAEIAEEMsBMggIABCABBDLATIICAAQgAQQywEyCAgAEIAEEMsBMggIABCABBDLATIGCAAQFhAeMgYIABAWEB4yBggAEBYQHjIGCAAQFhAeOgoIABBHENYEELADOgcIABCwAxBDOgUIABCABEoECEEYAFC5BVi2CmC4DGgCcAF4AIABnwGIAeAEkgEDMC40mAEAoAEByAEJwAEB&sclient=gws-wiz-serp);
   - [`SOLID principles`](https://www.google.com/search?q=SOLID+principles&rlz=1C5CHFA_enBR1041BR1041&oq=SOLID+principles&aqs=chrome..69i57j69i60j69i61.152j0j4&sourceid=chrome&ie=UTF-8);
@@ -93,25 +94,22 @@ This project took me out of my comfort zone, and I'm very happy with the result.
 
 ## 🤔 How to Use
 
-```
-First of all, correctly configure the Flutter development environment on your machine, 
-see https://flutter.dev/docs/get-started/install
+First of all, configure the Flutter development environments, see <https://flutter.dev/docs/get-started/install>.
 
 - Clone this repository:
-$ git clone https://github.com/felipecastrosales/site
+`$ git clone https://github.com/felipecastrosales/site`
 
 - Enter in directory:
-$ cd site
+`$ cd site`
 
 - Open in your favorite editor (e.g. VSCode):
-$ code .
+`$ code .`
 
 - For install dependencies:
-$ flutter pub get
+`$ flutter pub get`
 
 - Run the app:
-$ flutter run
-```
+`$ flutter run`
 
 ---
 
@@ -123,14 +121,12 @@ If you want to do this project with yours informations and datas, see the [Want
 
 ## 🤝 Contributing
 
-```
 - Fork this repository;
 - Create a branch with your feature: git checkout -b my-feature;
 - Commit your changes: git commit -m 'feat: My new feature';
 - Push your branch: git push origin my-feature.
 - Make a pull request, describing the changes you made and await approval.
 - You can also make suggestions by opening an issue, reporting bugs or requesting new features.
-```
 
 If you plan to contribute even more, see the [Contribution Guide](.github/docs/CONTRIBUTING.md).
 
@@ -148,7 +144,8 @@ See [Changelog](.github/docs/CHANGELOG.md).
 
 ---
 
->This project was developed with ❤️ by **[@Felipe Sales](https://www.linkedin.com/in/felipecastrosales/)**, with [Karol de Paula](https://www.instagram.com/karoldepaulasm/) and [Daniel Duarte](https://www.linkedin.com/in/daniel2d/). My sincere and true thanks.<br>
+>This project was developed with ❤️ by **[@Felipe Sales](https://www.linkedin.com/in/felipecastrosales/)**, with [Karol de Paula](https://www.instagram.com/karoldepaulasm/) and [Daniel Duarte](https://www.linkedin.com/in/daniel2d/). My sincere and true thanks.
+
 If it helped you, give ⭐, contribute, it will help me too.
 
 ---