Skip to content

Don't fix version in devcontainer.json #1006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"name": "Jekyll",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/jekyll:2-bullseye",
"image": "mcr.microsoft.com/devcontainers/jekyll",

// Features to add to the dev container. More info: https://containers.dev/features.
"features": {
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@

New testimonials are very welcome!

Simply add a new markdown file to the `_testimonials` folder. Take a look at the existing testimonials for the correct formatting and YAML frontmatter.

Check failure on line 25 in README.md

View workflow job for this annotation

GitHub Actions / lint

Line length

README.md:25:101 MD013/line-length Line length [Expected: 100; Actual: 151] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

## Code snippet/examples

The code examples in the "code snippet carousel" are kept as individual markdown files in the `_snippets` folder. Please check the structure of existing snippets if you'd like to add a new one.

Check failure on line 29 in README.md

View workflow job for this annotation

GitHub Actions / lint

Line length

README.md:29:101 MD013/line-length Line length [Expected: 100; Actual: 193] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

The "code content" is in the YAML frontmatter and requires the "literal scalar block style", i.e. start with a `|` character, and indent the code block by four spaces.

Check failure on line 31 in README.md

View workflow job for this annotation

GitHub Actions / lint

Line length

README.md:31:101 MD013/line-length Line length [Expected: 100; Actual: 167] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Note also the use of an excerpt separator `<!--more-->`. This is to ensure that only the content above that separator will appear on mobile (due to space constraints).

Check failure on line 33 in README.md

View workflow job for this annotation

GitHub Actions / lint

Line length

README.md:33:101 MD013/line-length Line length [Expected: 100; Actual: 167] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Example:

Expand All @@ -55,34 +55,35 @@

## Developing locally

The easiest way to get started developing this repository on your own machine is by using the supplied dev container.

Check failure on line 58 in README.md

View workflow job for this annotation

GitHub Actions / lint

Line length

README.md:58:101 MD013/line-length Line length [Expected: 100; Actual: 117] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

### Using the Dev Container

1. Open the repository in Visual Studio Code.
2. When prompted, reopen the repository in the dev container.
3. The dev container will automatically set up the development environment.
1. Install and run [Docker](https://www.docker.com/).
2. Open the repository in [Visual Studio Code](https://code.visualstudio.com/).
3. When prompted, reopen the repository in the dev container.
4. The dev container will automatically set up the development environment.

**Summary of using a dev container:**
A dev container is a pre-configured development environment that includes all the necessary tools and dependencies. It allows you to start developing without having to manually set up your environment.

Check failure on line 68 in README.md

View workflow job for this annotation

GitHub Actions / lint

Line length

README.md:68:101 MD013/line-length Line length [Expected: 100; Actual: 201] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

If not using VSCode, consult your preferred IDE's documentation for instructions.

You may need to run the following once to install TailwindCSS dependency:

```

Check failure on line 74 in README.md

View workflow job for this annotation

GitHub Actions / lint

Code block style

README.md:74 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md046.md

Check failure on line 74 in README.md

View workflow job for this annotation

GitHub Actions / lint

Fenced code blocks should have a language specified

README.md:74 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md040.md
npm i
```

To start the development server, run the following command:

```sh

Check failure on line 80 in README.md

View workflow job for this annotation

GitHub Actions / lint

Code block style

README.md:80 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md046.md
bundle exec jekyll serve
```

Or, to enable live reloading:

```sh

Check failure on line 86 in README.md

View workflow job for this annotation

GitHub Actions / lint

Code block style

README.md:86 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md046.md
bundle exec jekyll serve -l
```

Expand Down