Add mardownlint

playcanvas · Apr 26, 2024 · f2d8dc2 · f2d8dc2
1 parent e0eb1d8
commit f2d8dc2
Show file tree

Hide file tree

Showing 7 changed files with 209 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -5,21 +5,21 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
 ### Installation
 
 ```
-$ yarn
+yarn
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+yarn start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
-$ yarn build
+yarn build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
 Using SSH:
 
 ```
-$ USE_SSH=true yarn deploy
+USE_SSH=true yarn deploy
 ```
 
 Not using SSH:
 
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+GIT_USER=<Your GitHub username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/blog/2023-02-07-how-to-make-your-html5-games-awesome.md b/blog/2023-02-07-how-to-make-your-html5-games-awesome.md
@@ -366,7 +366,7 @@ The combined effects look like this:
 
 You'll notice I've added screen shake to more than just the player getting hit! I'm a big fan of this effect, so I've added it to asteroid explosions and firing bullets as well!
 
-## And that about does it!
+## And that about does it
 
 With the effects we added above, the game looks and plays entirely different. Destroying asteroids **feels** good, and everything else in the game is there to enhance that experience.
 

diff --git a/blog/2023-06-07-moving-from-wordpress-to-jekyll-a-case-study.md b/blog/2023-06-07-moving-from-wordpress-to-jekyll-a-case-study.md
@@ -32,16 +32,19 @@ First up, I should say that you should make use of ChatGPT when you attempt some
 
 1. **Export Your WordPress Content.** On your WordPress Dashboard, navigate to Tools > Export and select 'All Content'. Click 'Download Export File'. You should receive an XML file that contains all of your site’s content.
 2. **Convert WordPress Export to Jekyll Format.** To convert your WordPress export file to a Jekyll-friendly format, you can use a tool called `exitwp`. Here are the steps:
-  - Clone or download `exitwp` from its [GitHub repository](https://github.com/thomasf/exitwp).
-  - Put your WordPress XML file in the `wordpress-xml` directory in the `exitwp` directory.
-  - Run `exitwp` (requires Python and some libraries, see the repo's `README` for details).
-  - This will generate a `_posts` directory containing all your blog posts converted into markdown format that Jekyll understands.
+
+- Clone or download `exitwp` from its [GitHub repository](https://github.com/thomasf/exitwp).
+- Put your WordPress XML file in the `wordpress-xml` directory in the `exitwp` directory.
+- Run `exitwp` (requires Python and some libraries, see the repo's `README` for details).
+- This will generate a `_posts` directory containing all your blog posts converted into markdown format that Jekyll understands.
+
 3. **Setting Up Jekyll.**
-  - Install Ruby and Jekyll. For installation guide refer to [Jekyll's official site](https://jekyllrb.com/docs/installation/).
-  - Create a new Jekyll site by typing `jekyll new my-awesome-site` in the command line.
-  - Replace the `_posts` directory in your new Jekyll site with the `_posts` directory that `exitwp` generated.
-  - You can run your site locally to see how it looks by using the command `bundle exec jekyll serve`.
-  - Then, open your browser to http://localhost:4000.
+
+- Install Ruby and Jekyll. For installation guide refer to [Jekyll's official site](https://jekyllrb.com/docs/installation/).
+- Create a new Jekyll site by typing `jekyll new my-awesome-site` in the command line.
+- Replace the `_posts` directory in your new Jekyll site with the `_posts` directory that `exitwp` generated.
+- You can run your site locally to see how it looks by using the command `bundle exec jekyll serve`.
+- Then, open your browser to http://localhost:4000.
 
 Once I had our blog post content successfully exported to a basic Jekyll site, I checked everything in to a new [GitHub repository](https://github.com/playcanvas/blog). From this point, I wanted any change I made to the content to be tracked via Git version control - I mean, why wouldn't you?
 

diff --git a/blog/2023-06-26-playcanvas-adds-sketchfab-itegration.md b/blog/2023-06-26-playcanvas-adds-sketchfab-itegration.md
@@ -53,6 +53,6 @@ Sketchfab assets are all tagged with a license and an author. When you import Sk
 
 This ensures that the author's licensing wishes are respected and that they recieve credit for their work.
 
-### Go Forth and Create!
+### Go Forth and Create
 
-With today's release, it's never been easier to create interactive 3D experiences for the web. We hope you love the new Sketchfab integration. But, as always, we *love* to hear your opinions so head over to the [forum](https://forum.playcanvas.com/t/playcanvas-integrates-sketchfab/31885) and join the conversation. Happy creating! 🚧👷
+With today's release, it's never been easier to create interactive 3D experiences for the web. We hope you love the new Sketchfab integration. But, as always, we _love_ to hear your opinions so head over to the [forum](https://forum.playcanvas.com/t/playcanvas-integrates-sketchfab/31885) and join the conversation. Happy creating! 🚧👷
diff --git a/blog/2023-10-11-avif-webp-lands-in-editor.md b/blog/2023-10-11-avif-webp-lands-in-editor.md
@@ -15,15 +15,15 @@ tags:
 
 ![AVIF + WebP Support](/img/avif-webp-icons.png)
 
-#### Today we're excited to announce that PlayCanvas now supports WebP and AVIF images natively in the editor. Two new, efficient image formats built for the web.
+#### Today we're excited to announce that PlayCanvas now supports WebP and AVIF images natively in the editor. Two new, efficient image formats built for the web
 
 This is not just an exciting update for us but a game-changer for anyone looking to optimize their projects for faster load times and better quality.
 
 JPGs and PNGs have served us well. They're reliable and you can use them everywhere. AVIF and WebP are the new kids on the block. They offer better compression with a wider range of features like alpha channels, HDR and wide color gamut. But how do these formats work in practice and are they really that good? Let's dive in.
 
 _Take a look at the following images_
 <br/>
-<iframe 
+<iframe
   src="https://codesandbox.io/embed/react-compare-image-forked-myp5cp?fontsize=14&hidenavigation=1&theme=dark"
   style={{
     width: "100%",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -30,7 +30,8 @@
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids"
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "lint": "markdownlint-cli2 blog README.md"
   },
   "dependencies": {
     "@docusaurus/core": "3.2.1",
@@ -44,7 +45,8 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.2.1",
-    "@docusaurus/types": "3.2.1"
+    "@docusaurus/types": "3.2.1",
+    "markdownlint-cli2": "^0.13.0"
   },
   "browserslist": {
     "production": [