Add titlecase linting and fix content

Signed-off-by: karthik Ganeshram <[email protected]>

Author: karthik2804

Diff for: .markdownlint-cli2.mjs

@@ -0,0 +1,34 @@
+const options = {
+    "config": {
+        "default": false,
+        "extends": null,
+        // Headings can increment by only one step (h1 -> h2) and not (h1 -> h3)
+        "heading-increment": true,
+        // Multiple blank lines will throw an error
+        "no-multiple-blanks": true,
+        // Headings should be surrounded by new lines
+        "blanks-around-headings": true,
+        // Headings always start on new lines
+        "heading-start-left": true,
+        // Code blocks must have an empty line above and below them
+        "blanks-around-fences": true,
+        // There can not be empty spaces in links
+        "no-space-in-links": true,
+        // Links must always contain url or "#"
+        "no-empty-links": true,
+        // Images must contain alt texts
+        "no-alt-text": true,
+        // Enforce consistent style for code blocks
+        "code-block-style": {
+            "style": "fenced"
+        },
+        // Enforce consistent fence style for code blocks
+        "code-fence-style": {
+            "style": "backtick"
+        },
+        "titlecase-rule": true
+    },
+    "customRules": ["markdownlint-rule-titlecase"]
+}
+
+export default options;

Diff for: .markdownlint.jsonc

@@ -44,7 +44,7 @@ cd ~/bartholomew
 Rust and the wasm32-wasi target are prerequisites that are required to build Bartholomew from the source code. Please see the next section if you require these prerequisites on your system.
 
 ---
-
+<!-- markdownlint-disable-next-line titlecase-rule -->
 ## Prerequisites (Rust, wasm32-wasi and wasm-opt)
 
 You will need Rust installed.
@@ -354,7 +354,7 @@ The final stage of a successful contribution will be a notification that the PR
 
 ![PR merged](../static/image/docs/merged.png)
 
-## Thank you
+## Thank You
 
 At this point, you have performed a significant amount of work which is greatly appreciated. 
 

Diff for: content/bartholomew/contributing.md

@@ -102,7 +102,7 @@ If your syntax in the `.md` file is **correct**, you will receive an output simi
 ✅ content/blog/protons.md
 ```
 
-### Validating content with shortcodes
+### Validating Content With Shortcodes
 
 If some of your documents uses shortcodes, then directory from which the shortcodes must be loaded needs to be specified using the `--shortcodes` flag.
 

Diff for: content/bartholomew/quickstart.md

@@ -13,7 +13,7 @@ Bartholomew provides the Rhai scripting language for this.
 [Rhai](https://rhai.rs/) is a simple scripting language that has many stylistic similarities to
 Rust, Go, and Python. The integration with Bartholomew is easy to work with.
 
-## The basic
+## The Basic
 
 1. Create a file in `scripts/` with the extension `.rhai`
 2. Put some Rhai code in there
@@ -50,7 +50,7 @@ When we run the template, we will see:
 hello world
 ```
 
-## A more complicated example.
+## A More Complicated Example.
 
 Let's take a look at `scripts/blogs.rhai`, which is called in a template as `blogs`.
 This script makes a list of all of the blog posts for the site.

Diff for: content/bartholomew/scripting.md

@@ -6,7 +6,7 @@ template = "bartholomew_main"
 
 ---
 
-## Google Verification using Bartholomew
+## Google Verification Using Bartholomew
 
 Your Bartholomew implementation can be <a href="https://support.google.com/webmasters/answer/9008080?hl=en" target="_blank">officially verified with Google</a>. This is an important first step because the verification process provides you with access to the <a href="https://g.co/kgs/UcBemE" target="_blank">Google Search Console</a>. The Google Search Console (formerly Google Webmaster Tools) allows webmasters to check indexing status, search queries, crawling errors and also optimize visibility of their site.
 
@@ -42,7 +42,7 @@ google-site-verification: abcdefg.html
 
 At this point the verification button in the Google dashboard can be pressed; Google fetches the file from your site and the verification is complete!
 
-## Search Engine Optimization (SEO) using Bartholomew
+## Search Engine Optimization (SEO) Using Bartholomew
 
 In addition to just verifying the ownership of a site/domain, You can see that there are <a href="https://developers.google.com/search/docs/beginner/seo-starter-guide" target="_blank">specific SEO requirements</a> in relation to how the <a href="https://g.co/kgs/p6qtQs" target="_blank">Googlebot</a> indexes content. Googlebot is the web crawler software used by Google.
 

Diff for: content/bartholomew/seo.md

@@ -11,15 +11,15 @@ Shortcodes are simple reusable snippets can be used inside the markdown content.
 
 Bartholomew supports shortcodes simplify sharing content between different markdown files. 
 
-## The basic
+## The Basic
 
 1. Create a file in shortcodes/ with the extension `.rhai`
 2. Put some Rhai code in there
 3. Make the code return the required value
 4. Enable shortcodes in the markdown document
 5. Use it in the content
 
-## Creating a shortcode
+## Creating a Shortcode
 
 An example of a shortcode is in `shortcodes/alert.rhai`. The shortcode is available in the markdown file as `alert` just like for scripts.
 
@@ -71,7 +71,7 @@ let icons = #{
 
 ```
 
-## Enabling shortcodes
+## Enabling Shortcodes
 
 To enable shortcodes support for a particular document, the value of `enable_shortcodes = true` must be set in the page head.
 
@@ -85,7 +85,7 @@ enable_shortcodes = true
 ---
 ```
 
-## Using shortcodes
+## Using Shortcodes
 
 Now the shortcode can be used in the markdown file by calling it with the required arguments. For the alerts script, this is the type of alert and the message to be displayed.
 
@@ -97,7 +97,7 @@ Which renders as the following.
 
 {{ alert "warning" "Bartholomew is a work in progress" }}
 
-## Note while using shortcodes
+## Note While Using Shortcodes
 
 An important note to be considered while using shortcodes is that the `\{{ }}` must be escaped if they are not meant to be executed. This is only required in the content files where shortcodes are enabled.
 

Diff for: content/bartholomew/shortcodes.md

@@ -13,7 +13,7 @@ In Bartholomew, layout is handled via templates. All templates are in the
 While the version of Handlebars used in Bartholomew is written in Rust, not JavaScript,
 it works almost identically.
 
-## A simple template
+## A Simple Template
 
 Here is a simple HTML template with Handlebars:
 
@@ -37,7 +37,7 @@ then fills in the `body` with the value of `page.body`.
 
 Let's take a brief look at the `page` object to understand what is happening here.
 
-### The `page` object
+### The `page` Object
 
 In JSON, the `page` object looks like this:
 
@@ -60,7 +60,7 @@ In JSON, the `page` object looks like this:
 To access a part, you simply use a dotted path notation. So to get the value of `key` in
 the `extra` section, we use `{{ page.head.extra.key }}`.
 
-### The `site` object
+### The `site` Object
 
 In addition to the `page` object, there is also a `site` object. `site.pages` contains the `head` section and content of every page in the site. `site.pages` is only populated for templates included in `index_site_pages` in `site.toml` as described in the [configuration section](./configuration.md): 
 
@@ -84,7 +84,7 @@ In addition to the `page` object, there is also a `site` object. `site.pages` co
 Note that the `site.pages` array has access to every single document in the `content` folder.
 This part of the API may change in the future, as it does not scale terribly well. 
 
-### The `env` object
+### The `env` Object
 
 The third top-level object is `env`, which holds all of the environment data.
 
@@ -107,7 +107,7 @@ You can dump the entire contents of `env` using a template like this:
 </ul>
 ```
 
-### The `request` object
+### The `request` Object
 
 The fourth top-level object is `request`, which holds all the details about
 the HTTP request, the path of this resource, and other Spin information.
@@ -131,7 +131,7 @@ You can dump the entire contents of `request` using a template like this:
 </ul>
 ```
 
-## Including a template
+## Including a Template
 
 It is possible to include a template into another template.
 For example, if we want to include the `navbar.hbs` template, we use a "partial" include
@@ -143,7 +143,7 @@ like this:
 
 Note that we drop the `.hbs` suffix when including this way.
 
-## Calling template helpers
+## Calling Template Helpers
 
 There are a few template helpers defined in Bartholomew.
 
@@ -157,7 +157,7 @@ The above will render `HELLO`.
 
 Note that you can create custom template helpers using [Rhai scripts](./scripting.md).
 
-### Defined helper functions
+### Defined Helper Functions
 
 The following helper functions are provided with Bartholomew
 
@@ -170,7 +170,7 @@ The following helper functions are provided with Bartholomew
 - `abbrev UINT STRING`: Shorten the string to UINT with elipses. For example `abbrev 8 "Functions Example"` returns `Funct...`.
 - `plural INT SINGULAR_STRING PLURAL_STRING`: If `INT` is `1`, return the singular form. Otherwise return plural: `plural 1 "apple" "apples"` returns `apple`. But if we change `1` to `2` (or `0`) it will return `apples`.
 
-### Values reference
+### Values Reference
 
 The following values are available in the template. This is formatted in YAML for readability. The four top-level objects are:
 

Diff for: content/bartholomew/templates.md

@@ -8,7 +8,7 @@ template = "bartholomew_main"
 
 Bartholomew supports theming which allows for easy customization of the site along with the user-defined tempaltes.
 
-## Adding a theme
+## Adding a Theme
 
 Once the initial site has been set up using the [quickstart section](./quickstart), create a themes folder where you will be able to download different themes.
 
@@ -25,7 +25,7 @@ git submodule add <Source_to_the_theme>
 
 Multiple themes can be added to the themes directory but only one of them will be active at a given time as described in the next section.
 
-## Configuring the site to use the theme
+## Configuring the Site to Use the Theme
 
 To choose a theme for the website, the `theme` attribute in `config/site.toml` must be configured, where the value is the name of the theme as found in the `themes/` folder.
 
@@ -59,7 +59,7 @@ files = [ {source = "themes/<name of theme>/static", destination ="/"}, { source
 route = "/static/..."
 ```
 
-## Template precedence
+## Template Precedence
 
 When a theme is enabled for a site, both the user-defined and theme-provided assets like the templates, scripts and static assets will be available. If a theme-provided asset and user-provided asset have the same name, the user-defined asset takes precedence. This allows for the user to override the theme to allow for customization. 
 

Diff for: content/bartholomew/themes.md

@@ -132,7 +132,7 @@ fn publish(_req: Request) -> Result<Response> {
 }
 ```
 
-## Log into Fermyon Cloud
+## Log Into Fermyon Cloud
 
 We need to log into Fermyon Cloud, so that we can build/deploy our application. For example:
 

Diff for: content/cloud/data-redis.md

@@ -5,20 +5,20 @@ enable_shortcodes = true
 
 ---
 
-- [Sign in to the Fermyon Cloud website](#sign-in-to-the-fermyon-cloud-website)
-- [Delete your application](#delete-your-application)
-- [Next steps](#next-steps)
+- [Sign in to the Fermyon Cloud Website](#sign-in-to-the-fermyon-cloud-website)
+- [Delete Your Application](#delete-your-application)
+- [Next Steps](#next-steps)
 
 It’s super easy to delete your application with Fermyon Cloud. This can be done in just a few steps using the Fermyon Cloud website.
 
-## Sign in to the Fermyon Cloud website
+## Sign in to the Fermyon Cloud Website
 
 1. Go to [https://cloud.fermyon.com](https://cloud.fermyon.com)
 1. Sign in using GitHub
 
 ![Fermyon Cloud login page](/static/image/login.png)
 
-## Delete your application
+## Delete Your Application
 
 1. Click on the application (**cloud_start** in the picture below), to open the application drawer.
 
@@ -34,7 +34,7 @@ It’s super easy to delete your application with Fermyon Cloud. This can be don
 
 That’s all about deleting your Spin Application on the Fermyon Cloud!
 
-## Next steps
+## Next Steps
 
 - Make sure to check the [FAQ and Known Limitations](faq) article
 - Find known issues and file new ones with this [GitHub repository](https://github.com/fermyon/feedback)

Diff for: content/cloud/delete.md

@@ -6,9 +6,9 @@ enable_shortcodes = true
 ---
 
 - [Prerequisites - Install the Spin CLI](#prerequisites---install-the-spin-cli)
-- [Login to the Fermyon Cloud](#login-to-the-fermyon-cloud)
-- [Deploy your application](#deploy-your-application)
-- [Next steps](#next-steps)
+- [Log in to the Fermyon Cloud](#log-in-to-the-fermyon-cloud)
+- [Deploy Your Application](#deploy-your-application)
+- [Next Steps](#next-steps)
 
 This article will guide you through deploying a Spin Application with the Fermyon Cloud. You can deploy your [Spin App](/spin) or [Bartholomew](https://github.com/fermyon/bartholomew) site in just a few steps.
 
@@ -44,7 +44,7 @@ Device authorized!
 
 This command generates an authentication code for your device to be authorized on the Fermyon Cloud. 
 
-## Deploy your application
+## Deploy Your Application
 
 After having signed in to the Fermyon Cloud, you deploy the application, by running the following command in the directory where your applications `spin.toml` file is located.
 
@@ -64,6 +64,6 @@ Take a look at the [Quickstart article](quickstart) for how to get a pre-built a
 
 **Congratulations on deploying your Spin Application! 🥳**
 
-## Next steps
+## Next Steps
 
 - Next, let's look at [how to upgrade an application](upgrade).