Skip to content

[ADD] local installation commands #399

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

[ADD] local installation commands #399

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
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,34 @@ module.exports = {
};
```





Run locally
If you want to work on the library itself or preview the documentation on your machine, follow these steps:

Comment on lines +86 to +88
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ 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.

Suggested change
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.
Comment on lines +89 to +98
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ 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.


Common additional commands:

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
Comment on lines +102 to +106
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ 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.

Suggested change
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.




## Components

<table>
Expand Down Expand Up @@ -382,4 +410,4 @@ If you need the Figma files for the components you can check out our website for

The Flowbite name and logos are trademarks of Crafty Dwarf Inc.

📝 [Read about the licensing terms](https://flowbite.com/getting-started/license/)
📝 [Read about the licensing terms](https://flowbite.com/getting-started/license/)