[ADD] local installation commands #399
Conversation
✅ Deploy Preview for sensational-seahorse-8635f8 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe README.md file was updated to add a new "Run locally" section, providing step-by-step instructions for setting up the project and previewing documentation. It also introduces a table summarizing common npm commands for building, testing, linting, and cleaning the project. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
90-90: Bare URL used
(MD034, no-bare-urls)
98-98: Bare URL used
(MD034, no-bare-urls)
102-102: Hard tabs
Column: 8
(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 31
(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 15
(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 25
(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 37
(MD010, no-hard-tabs)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - sensational-seahorse-8635f8
- GitHub Check: Header rules - sensational-seahorse-8635f8
- GitHub Check: Pages changed - sensational-seahorse-8635f8
| Run locally | ||
| If you want to work on the library itself or preview the documentation on your machine, follow these steps: | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use a proper Markdown heading for discoverability and TOC generation.
Plain text "Run locally" won’t be picked up by most Markdown tooling, including the auto-generated TOC at the top of this file. Promote it to a second-level heading.
-Run locally
+## Run locally📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Run locally | |
| If you want to work on the library itself or preview the documentation on your machine, follow these steps: | |
| ## Run locally | |
| If you want to work on the library itself or preview the documentation on your machine, follow these steps: |
🤖 Prompt for AI Agents
In README.md around lines 86 to 88, the text "Run locally" is plain text and
should be changed to a proper Markdown second-level heading by prefixing it with
"##". This will improve discoverability and allow it to be included in the
auto-generated table of contents.
| # 1. Clone the repository | ||
| git clone https://github.com/themesberg/flowbite-vue.git | ||
| cd flowbite-vue | ||
|
|
||
| # 2. Install dependencies (requires Node.js 18+ and npm 10+) | ||
| npm install | ||
|
|
||
| # 3. Start the VitePress development server | ||
| npm run dev | ||
| After the server starts, open the URL shown in the terminal (usually http://localhost:5173) to view the documentation site. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Wrap shell commands in fenced code blocks and avoid bare URLs.
Without back-ticks the hash-prefixed lines render as headings, the commands aren’t copy-paste-friendly, and markdown-lint flags the bare URL (MD034).
-# 1. Clone the repository
-git clone https://github.com/themesberg/flowbite-vue.git
-cd flowbite-vue
-
-# 2. Install dependencies (requires Node.js 18+ and npm 10+)
-npm install
-
-# 3. Start the VitePress development server
-npm run dev
-After the server starts, open the URL shown in the terminal (usually http://localhost:5173) to view the documentation site.
+# 1. Clone the repository
+```bash
+git clone https://github.com/themesberg/flowbite-vue.git
+cd flowbite-vue
+```
+
+# 2. Install dependencies (requires Node.js 18+ and npm 10+)
+```bash
+npm install
+```
+
+# 3. Start the VitePress development server
+```bash
+npm run dev
+```
+
+After the server starts, open the URL shown in the terminal (usually <http://localhost:5173>) to view the documentation site.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
90-90: Bare URL used
(MD034, no-bare-urls)
98-98: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In README.md around lines 89 to 98, the shell commands are not wrapped in fenced
code blocks, causing markdown rendering issues and markdown-lint warnings for
bare URLs. Fix this by enclosing all shell commands in triple backtick code
blocks with "bash" specified for syntax highlighting. Also, replace the bare URL
with a markdown link or wrap it in angle brackets to avoid lint errors.
| Purpose Command | ||
| Build documentation site npm run build | ||
| Run unit tests npm run test | ||
| Lint and fix files npm run lint-fix | ||
| Clear build and cache artifacts npm run clear |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace the tab-separated list with a Markdown table to satisfy MD010 and improve readability.
Hard tabs trigger markdown-lint (MD010) and the current layout collapses on small screens.
-Purpose Command
-Build documentation site npm run build
-Run unit tests npm run test
-Lint and fix files npm run lint-fix
-Clear build and cache artifacts npm run clear
+| Purpose | Command |
+|---------------------------------|-------------------|
+| Build documentation site | `npm run build` |
+| Run unit tests | `npm run test` |
+| Lint and fix files | `npm run lint-fix`|
+| Clear build and cache artifacts | `npm run clear` |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Purpose Command | |
| Build documentation site npm run build | |
| Run unit tests npm run test | |
| Lint and fix files npm run lint-fix | |
| Clear build and cache artifacts npm run clear | |
| | Purpose | Command | | |
| |---------------------------------|--------------------| | |
| | Build documentation site | `npm run build` | | |
| | Run unit tests | `npm run test` | | |
| | Lint and fix files | `npm run lint-fix` | | |
| | Clear build and cache artifacts | `npm run clear` | |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
102-102: Hard tabs
Column: 8
(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 31
(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 15
(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 25
(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 37
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In README.md around lines 102 to 106, replace the current tab-separated list of
commands and their purposes with a properly formatted Markdown table. Use pipe
characters and hyphens to create a table header and rows, ensuring each command
and its description are in separate columns. This will fix the MD010
markdown-lint issue caused by hard tabs and improve readability on small
screens.
local installation commands
Summary by CodeRabbit