wwt / git-foundations Goto Github PK

Add markdownlint configuration file to support the VS Code markdownlint extension.

Add condition to only build when a PR closes.

Required to make repository public.

I suggest we convert the Note blocks to proper admonitions with the following syntax. This would use the admonition extension already installed in our mkdocs.yml configuration.

!!! note
    :warning: Github usernames are case-sensitive, so be sure to double-check your filename

which results in ....

mkdocs renders images on a scale which makes it difficult to read embedded text.

I want to create a user-friendly documentation style for the Hands-on walkthrough. Having the documentation hosted on Github pages can also enable access to the tutorial content without requiring Github access (if Pages is set to public)

Present visitors information about the repo and how to contribute

Create GH action to build and deploy site on GH pages

Require files to comply with markdownlint rules

The raw markdown for ordered lists renders properly although the markdown does not render properly in mkdocs. For example this:

1. Some text
2. Some text

3. Some text

Renders in markdown like this:

1. Some text

2. Some text

3. Some text

Renders in mkdocs like this

1. Some text

2. Some text

3. Some text

Prevent people from navigating away from the lab walkthrough when they follow external links.

We need to cleanup some of the grammar and syntax within all of the sections.

Assignees:
Labels: enhancement