|
3 | 3 | [](https://github.com/riligar/knowledge/stargazers)  [](https://myknowledge.click) [ |
4 | 4 | ](https://www.npmjs.com/package/@riligar/knowledge) |
5 | 5 |
|
6 | | -> Transform how your team creates, organizes, and shares knowledge |
7 | | -
|
8 | 6 | ## 🎯 What is Knowledge? |
9 | 7 |
|
10 | 8 | **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. |
85 | 83 |
|
86 | 84 | ### 3. **Generate documentation** |
87 | 85 | ```bash |
88 | | -# Development with live reload |
89 | | -knowledge dev |
90 | | - |
91 | 86 | # Production (static files) |
92 | 87 | knowledge build |
93 | 88 |
|
@@ -210,21 +205,6 @@ npm install my-project |
210 | 205 | - Standard format for examples |
211 | 206 | - Consistent tone of voice |
212 | 207 |
|
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 |
228 | 208 |
|
229 | 209 | ## 📊 Comparison with Other Tools |
230 | 210 |
|
|
0 commit comments