Skip to content

Commit 64cd90e

Browse files
committed
docs: streamline README.md by removing outdated sections and simplifying instructions
1 parent 619f162 commit 64cd90e

File tree

1 file changed

+0
-20
lines changed

1 file changed

+0
-20
lines changed

README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
[![GitHub stars](https://img.shields.io/github/stars/riligar/knowledge)](https://github.com/riligar/knowledge/stargazers) ![GitHub License](https://img.shields.io/github/license/riligar/knowledge) [![Documentation](https://img.shields.io/badge/docs-Knowledge.click-blue)](https://myknowledge.click) [![NPM Version](https://img.shields.io/npm/v/%40riligar%2Fknowledge)
44
](https://www.npmjs.com/package/@riligar/knowledge)
55

6-
> Transform how your team creates, organizes, and shares knowledge
7-
86
## 🎯 What is Knowledge?
97

108
**Knowledge** is a modern static documentation generator that transforms Markdown files into professional documentation sites. It's the perfect tool for anyone who wants to create beautiful and functional documentation without complications.
@@ -85,9 +83,6 @@ Welcome! This is a simple example.
8583

8684
### 3. **Generate documentation**
8785
```bash
88-
# Development with live reload
89-
knowledge dev
90-
9186
# Production (static files)
9287
knowledge build
9388

@@ -210,21 +205,6 @@ npm install my-project
210205
- Standard format for examples
211206
- Consistent tone of voice
212207

213-
## 🎯 Recommended Workflow
214-
215-
### **For New Projects**
216-
1. **Plan** the documentation structure
217-
2. **Create** basic files (index, installation, guide)
218-
3. **Start** `bun run dev` for development
219-
4. **Write** and see changes in real time
220-
5. **Publish** with `bun run build`
221-
222-
### **For Existing Projects**
223-
1. **Migrate** existing documentation to Markdown
224-
2. **Organize** in logical folder structure
225-
3. **Configure** Knowledge with your preferences
226-
4. **Test** with `bun run dev`
227-
5. **Deploy** to replace old documentation
228208

229209
## 📊 Comparison with Other Tools
230210

0 commit comments

Comments
 (0)