Skip to content

feat: add devcontainer for documentation development #314

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.

Sign up for GitHub

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
mohitjeswani01 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add devcontainer for documentation development #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 31 additions & 0 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "Kmesh Website Development",
"image": "mcr.microsoft.com/devcontainers/javascript-node:20",

Comment on lines +2 to +4
// Install dependencies using yarn to match the project's lockfile
"postCreateCommand": "yarn install --frozen-lockfile",
Comment on lines +5 to +6

// Forward Docusaurus dev server port
"forwardPorts": [3000],
"portsAttributes": {
"3000": {
"label": "Docusaurus Dev Server",
"onAutoForward": "openBrowser"
}
},

// VS Code extensions and settings for documentation development
"customizations": {
"vscode": {
"extensions": [
"DavidAnson.vscode-markdownlint",
"streetsidesoftware.code-spell-checker",
"yzhang.markdown-all-in-one",
"dbaeumer.vscode-eslint"
Comment on lines +23 to +24

@gemini-code-assist gemini-code-assist Bot May 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The dbaeumer.vscode-eslint extension is included, but eslint is not listed as a dependency in package.json, nor is there an ESLint configuration file visible in the repository. Unless ESLint is being added to the project, this extension will not provide any functionality and can be removed to keep the development environment lean.

        "yzhang.markdown-all-in-one"

],
"settings": {
"terminal.integrated.defaultProfile.linux": "bash"
}
}
}
}
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,41 @@ updates:

---

## Development Environment

You can start developing with zero manual setup using either **GitHub Codespaces** or **VS Code Dev Containers**.

### Option 1: GitHub Codespaces (Recommended)

Click the button below to open the project in a ready-to-code cloud environment:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/kmesh-net/website)

Once the Codespace is ready, start the dev server:

```bash
npm start
# or
yarn start
```

### Option 2: VS Code Dev Containers (Local)

1. Install [Docker](https://www.docker.com/products/docker-desktop) and the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VS Code.
2. Clone the repository and open it in VS Code.
3. When prompted, click **"Reopen in Container"** — or run the command **Dev Containers: Reopen in Container** from the Command Palette.
4. Dependencies are installed automatically. Start the dev server:

```bash
npm start
# or
yarn start
```

Both options provide a pre-configured environment with Node.js 20 and recommended VS Code extensions for documentation development.

---

## How to Install

The Kmesh website is built using **Docusaurus** with React. Follow these steps to install and run it:
Expand Down
Loading