Skip to content

Commit 40b2507

Browse files
ciro-macielciro-maciel
committed
chore: rename project from Knowledge to Documentation and update related configurations
- Updated project name and references from "Knowledge" to "Documentation" across all files. - Modified `CHANGELOG.md`, `README.md`, and configuration files to reflect the new project identity. - Adjusted URLs and repository links to point to the new documentation site. - Ensured consistency in naming conventions throughout the codebase and documentation.
1 parent bfa72c9 commit 40b2507

32 files changed

+16542
-10029
lines changed

‎CHANGELOG.md‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,131 @@
1-
# [1.13.0](https://github.com/riligar/knowledge/compare/v1.12.1...v1.13.0) (2025-06-02)
1+
# [1.13.0](https://github.com/riligar/documentation/compare/v1.12.1...v1.13.0) (2025-06-02)
22

33

44
### Features
55

6-
* **analytics:** add analytics configuration and rendering support ([bdda6fb](https://github.com/riligar/knowledge/commit/bdda6fbeee9402cf372dc5d0f1b50ff31cc8fcf4))
6+
* **analytics:** add analytics configuration and rendering support ([bdda6fb](https://github.com/riligar/documentation/commit/bdda6fbeee9402cf372dc5d0f1b50ff31cc8fcf4))
77

8-
## [1.12.1](https://github.com/riligar/knowledge/compare/v1.12.0...v1.12.1) (2025-06-01)
8+
## [1.12.1](https://github.com/riligar/documentation/compare/v1.12.0...v1.12.1) (2025-06-01)
99

1010

1111
### Bug Fixes
1212

13-
* **download:** update download ZIP button styles and SVG icon ([d1aa1eb](https://github.com/riligar/knowledge/commit/d1aa1eb510ca088bd794338c78352c20ab3e4fcf))
13+
* **download:** update download ZIP button styles and SVG icon ([d1aa1eb](https://github.com/riligar/documentation/commit/d1aa1eb510ca088bd794338c78352c20ab3e4fcf))
1414

15-
# [1.12.0](https://github.com/riligar/knowledge/compare/v1.11.0...v1.12.0) (2025-06-01)
15+
# [1.12.0](https://github.com/riligar/documentation/compare/v1.11.0...v1.12.0) (2025-06-01)
1616

1717

1818
### Features
1919

20-
* **download:** add download ZIP button with loading state and styles ([4e9711b](https://github.com/riligar/knowledge/commit/4e9711bc4ac8e90c23539606c08ff380ab99b7e9))
20+
* **download:** add download ZIP button with loading state and styles ([4e9711b](https://github.com/riligar/documentation/commit/4e9711bc4ac8e90c23539606c08ff380ab99b7e9))
2121

22-
# [1.11.0](https://github.com/riligar/knowledge/compare/v1.10.0...v1.11.0) (2025-06-01)
22+
# [1.11.0](https://github.com/riligar/documentation/compare/v1.10.0...v1.11.0) (2025-06-01)
2323

2424

2525
### Features
2626

27-
* **generator:** add HTML entity decoding for code highlighting ([4d8bf27](https://github.com/riligar/knowledge/commit/4d8bf27259a76c0096b9f82651f6357f0c76f504))
28-
* **generator:** add internal link processing for Markdown to HTML conversion ([1d1c275](https://github.com/riligar/knowledge/commit/1d1c2751a55df2758af2ac63c056e6a13eba23b9))
27+
* **generator:** add HTML entity decoding for code highlighting ([4d8bf27](https://github.com/riligar/documentation/commit/4d8bf27259a76c0096b9f82651f6357f0c76f504))
28+
* **generator:** add internal link processing for Markdown to HTML conversion ([1d1c275](https://github.com/riligar/documentation/commit/1d1c2751a55df2758af2ac63c056e6a13eba23b9))
2929

30-
# [1.10.0](https://github.com/riligar/knowledge/compare/v1.9.0...v1.10.0) (2025-06-01)
30+
# [1.10.0](https://github.com/riligar/documentation/compare/v1.9.0...v1.10.0) (2025-06-01)
3131

3232

3333
### Features
3434

35-
* **markdown:** add validation for Markdown files to start with H1 ([14ea026](https://github.com/riligar/knowledge/commit/14ea026f59a1a473b4c17975e652da91aa0d3790))
35+
* **markdown:** add validation for Markdown files to start with H1 ([14ea026](https://github.com/riligar/documentation/commit/14ea026f59a1a473b4c17975e652da91aa0d3790))
3636

37-
# [1.9.0](https://github.com/riligar/knowledge/compare/v1.8.1...v1.9.0) (2025-06-01)
37+
# [1.9.0](https://github.com/riligar/documentation/compare/v1.8.1...v1.9.0) (2025-06-01)
3838

3939

4040
### Features
4141

42-
* **generator:** enhance documentation generation and asset handling ([3760ff1](https://github.com/riligar/knowledge/commit/3760ff1cf2e3a7b92518f7409823d3db3464b337))
42+
* **generator:** enhance documentation generation and asset handling ([3760ff1](https://github.com/riligar/documentation/commit/3760ff1cf2e3a7b92518f7409823d3db3464b337))
4343

44-
## [1.8.1](https://github.com/riligar/knowledge/compare/v1.8.0...v1.8.1) (2025-06-01)
44+
## [1.8.1](https://github.com/riligar/documentation/compare/v1.8.0...v1.8.1) (2025-06-01)
4545

4646

4747
### Bug Fixes
4848

49-
* update author name in knowledge.config.ts from 'RiliGar' to 'Ciro Cesar Maciel' ([d3f840b](https://github.com/riligar/knowledge/commit/d3f840b00fea3db6a8963975e4992dbe43117b3d))
49+
* update author name in documentation.config.ts from 'RiliGar' to 'Ciro Cesar Maciel' ([d3f840b](https://github.com/riligar/documentation/commit/d3f840b00fea3db6a8963975e4992dbe43117b3d))
5050

51-
# [1.8.0](https://github.com/riligar/knowledge/compare/v1.7.0...v1.8.0) (2025-06-01)
51+
# [1.8.0](https://github.com/riligar/documentation/compare/v1.7.0...v1.8.0) (2025-06-01)
5252

5353

5454
### Features
5555

56-
* **generator:** implement asset copying with cache busting ([7551135](https://github.com/riligar/knowledge/commit/75511358da3e4b53ffeddb63b5e10cce00b321ee))
56+
* **generator:** implement asset copying with cache busting ([7551135](https://github.com/riligar/documentation/commit/75511358da3e4b53ffeddb63b5e10cce00b321ee))
5757

58-
# [1.7.0](https://github.com/riligar/knowledge/compare/v1.6.0...v1.7.0) (2025-06-01)
58+
# [1.7.0](https://github.com/riligar/documentation/compare/v1.6.0...v1.7.0) (2025-06-01)
5959

6060

6161
### Features
6262

63-
* **cli:** enhance error handling and documentation in Portuguese ([f7435d0](https://github.com/riligar/knowledge/commit/f7435d00f3ecae1cf8c5cf7d4cf1a6fc69d95773))
63+
* **cli:** enhance error handling and documentation in Portuguese ([f7435d0](https://github.com/riligar/documentation/commit/f7435d00f3ecae1cf8c5cf7d4cf1a6fc69d95773))
6464

65-
# [1.6.0](https://github.com/riligar/knowledge/compare/v1.5.0...v1.6.0) (2025-06-01)
65+
# [1.6.0](https://github.com/riligar/documentation/compare/v1.5.0...v1.6.0) (2025-06-01)
6666

6767

6868
### Features
6969

70-
* **cli:** update installation and troubleshooting documentation ([ff25804](https://github.com/riligar/knowledge/commit/ff258049eb3ef16384a397fa7133e79cfa3cb4e4))
70+
* **cli:** update installation and troubleshooting documentation ([ff25804](https://github.com/riligar/documentation/commit/ff258049eb3ef16384a397fa7133e79cfa3cb4e4))
7171

72-
# [1.5.0](https://github.com/riligar/knowledge/compare/v1.4.0...v1.5.0) (2025-06-01)
72+
# [1.5.0](https://github.com/riligar/documentation/compare/v1.4.0...v1.5.0) (2025-06-01)
7373

7474

7575
### Features
7676

77-
* **cli:** enhance server startup with available port detection and static file handling ([b206ecb](https://github.com/riligar/knowledge/commit/b206ecb75d90cc62e2cd1f0777498e9db5638242))
77+
* **cli:** enhance server startup with available port detection and static file handling ([b206ecb](https://github.com/riligar/documentation/commit/b206ecb75d90cc62e2cd1f0777498e9db5638242))
7878

79-
# [1.4.0](https://github.com/riligar/knowledge/compare/v1.3.0...v1.4.0) (2025-06-01)
79+
# [1.4.0](https://github.com/riligar/documentation/compare/v1.3.0...v1.4.0) (2025-06-01)
8080

8181

8282
### Bug Fixes
8383

84-
* **cli:** correct targetDir check in project initialization steps ([1f15cdd](https://github.com/riligar/knowledge/commit/1f15cddd2d6fb2f0681478934dd00fb760e44f41))
84+
* **cli:** correct targetDir check in project initialization steps ([1f15cdd](https://github.com/riligar/documentation/commit/1f15cddd2d6fb2f0681478934dd00fb760e44f41))
8585

8686

8787
### Features
8888

89-
* **config:** add resolveThemesDir function to determine themes directory path ([17f116e](https://github.com/riligar/knowledge/commit/17f116e6ef41daeb76474b6e5a6efabc415ae2cc))
89+
* **config:** add resolveThemesDir function to determine themes directory path ([17f116e](https://github.com/riligar/documentation/commit/17f116e6ef41daeb76474b6e5a6efabc415ae2cc))
9090

91-
# [1.3.0](https://github.com/riligar/knowledge/compare/v1.2.1...v1.3.0) (2025-06-01)
91+
# [1.3.0](https://github.com/riligar/documentation/compare/v1.2.1...v1.3.0) (2025-06-01)
9292

9393

9494
### Features
9595

96-
* **server:** add helper functions for static file handling and content type determination ([1dbd588](https://github.com/riligar/knowledge/commit/1dbd5885ccfb796a3194df698c78c596e3b3e304))
96+
* **server:** add helper functions for static file handling and content type determination ([1dbd588](https://github.com/riligar/documentation/commit/1dbd5885ccfb796a3194df698c78c596e3b3e304))
9797

98-
## [1.2.1](https://github.com/riligar/knowledge/compare/v1.2.0...v1.2.1) (2025-06-01)
98+
## [1.2.1](https://github.com/riligar/documentation/compare/v1.2.0...v1.2.1) (2025-06-01)
9999

100100

101101
### Bug Fixes
102102

103-
* **cli:** update initialization steps to reflect new command structure for knowledge project ([0a9f8e3](https://github.com/riligar/knowledge/commit/0a9f8e3c86cf8499b0cdae46fb50fddce076103b))
103+
* **cli:** update initialization steps to reflect new command structure for knowledge project ([0a9f8e3](https://github.com/riligar/documentation/commit/0a9f8e3c86cf8499b0cdae46fb50fddce076103b))
104104

105-
# [1.2.0](https://github.com/riligar/knowledge/compare/v1.1.0...v1.2.0) (2025-06-01)
105+
# [1.2.0](https://github.com/riligar/documentation/compare/v1.1.0...v1.2.0) (2025-06-01)
106106

107107

108108
### Features
109109

110-
* update CLI versioning to dynamically read from package.json ([418effd](https://github.com/riligar/knowledge/commit/418effd7210aa323dba67984546d3b34229dc9d2))
110+
* update CLI versioning to dynamically read from package.json ([418effd](https://github.com/riligar/documentation/commit/418effd7210aa323dba67984546d3b34229dc9d2))
111111

112-
# [1.1.0](https://github.com/riligar/knowledge/compare/v1.0.1...v1.1.0) (2025-06-01)
112+
# [1.1.0](https://github.com/riligar/documentation/compare/v1.0.1...v1.1.0) (2025-06-01)
113113

114114

115115
### Features
116116

117-
* add markdown file download functionality and update styles ([8bd1d7b](https://github.com/riligar/knowledge/commit/8bd1d7b4c2a2e892e79b09fb3f1db85e8ac727ac))
117+
* add markdown file download functionality and update styles ([8bd1d7b](https://github.com/riligar/documentation/commit/8bd1d7b4c2a2e892e79b09fb3f1db85e8ac727ac))
118118

119-
## [1.0.1](https://github.com/riligar/knowledge/compare/v1.0.0...v1.0.1) (2025-06-01)
119+
## [1.0.1](https://github.com/riligar/documentation/compare/v1.0.0...v1.0.1) (2025-06-01)
120120

121121

122122
### Bug Fixes
123123

124-
* add publishConfig to package.json for public access ([40f007f](https://github.com/riligar/knowledge/commit/40f007fab59db87526c62c03d7f4a4824fba032b))
124+
* add publishConfig to package.json for public access ([40f007f](https://github.com/riligar/documentation/commit/40f007fab59db87526c62c03d7f4a4824fba032b))
125125

126126
# 1.0.0 (2025-06-01)
127127

128128

129129
### Features
130130

131-
* add test-release script for easier semantic-release testing ([7d1b3a7](https://github.com/riligar/knowledge/commit/7d1b3a7d6a2b5cade28c5bbcfefd7b789ef417e3))
131+
* add test-release script for easier semantic-release testing ([7d1b3a7](https://github.com/riligar/documentation/commit/7d1b3a7d6a2b5cade28c5bbcfefd7b789ef417e3))

‎CNAME‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
myknowledge.click
1+
documentation.riligar.click

‎README.md‎

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1-
# Knowledge - Modern Documentation Generator
1+
# Documentation - Modern Documentation Generator
22

3-
[![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)
4-
](https://www.npmjs.com/package/@riligar/knowledge)
3+
[![GitHub stars](https://img.shields.io/github/stars/riligar/documentation)](https://github.com/riligar/documentation/stargazers) ![GitHub License](https://img.shields.io/github/license/riligar/documentation) [![Documentation](https://img.shields.io/badge/docs-documentation.riligar.click-blue)](https://documentation.riligar.click) [![NPM Version](https://img.shields.io/npm/v/%40riligar%2Fdocumentation)
4+
](https://www.npmjs.com/package/@riligar/documentation)
55

6-
## 🎯 What is Knowledge?
6+
## 🎯 What is Documentation?
77

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.
8+
**Documentation** 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.
99

1010
## 📊 Expected ROI
1111

1212
### Time Saved
13+
1314
- **Before**: 4-8 hours for basic documentation
1415
- **After**: 30-60 minutes with prompt
1516
- **Savings**: 85-90% of time
1617

1718
### Improved Quality
19+
1820
- **Consistency**: Standardized templates
1921
- **Completeness**: Coverage of all aspects
2022
- **Usability**: Modern and navigable interface
2123

22-
2324
## 🚀 Features
2425

2526
- **Markdown-First**: Write documentation in familiar Markdown syntax
@@ -33,67 +34,67 @@
3334

3435
```bash
3536
# Global installation (recommended)
36-
npm install -g @riligar/knowledge
37+
npm install -g @riligar/documentation
3738

3839
# Or with bun
39-
bun add -g @riligar/knowledge
40+
bun add -g @riligar/documentation
4041

4142
# Or with yarn
42-
yarn global add @riligar/knowledge
43+
yarn global add @riligar/documentation
4344

4445
# Or with pnpm
45-
pnpm add -g @riligar/knowledge
46+
pnpm add -g @riligar/documentation
4647
```
4748

4849
## 🎯 Quick Start
4950

5051
1. **Initialize a new project**:
52+
5153
```bash
52-
knowledge init my-docs
54+
documentation init my-docs
5355
cd my-docs
5456
```
5557

5658
2. **Start development server**:
59+
5760
```bash
58-
knowledge dev
61+
documentation dev
5962
```
6063

6164
3. **Build for production**:
6265
```bash
63-
knowledge build
66+
documentation build
6467
```
6568

6669
## 🎨 What you get automatically
6770

68-
| Category | Features | Benefits |
69-
|----------|----------|----------|
71+
| Category | Features | Benefits |
72+
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
7073
| **Professional Interface** | • Modern and clean design<br>• Automatic sidebar navigation<br>• Breadcrumbs and table of contents<br>• Search with Ctrl+K | • Professional appearance<br>• Easy navigation<br>• Quick content discovery<br>• Instant search functionality |
71-
| **Advanced Features** | • Copy-to-clipboard in code blocks<br>• Functional internal links<br>• SEO optimized<br>• Full accessibility | • Developer-friendly<br>• Seamless navigation<br>• Better search rankings<br>• Inclusive for all users |
72-
| **Mobile Experience** | • Collapsible menu<br>• Touch-friendly<br>• Fast loading<br>• Smooth scrolling | • Mobile-first design<br>• Intuitive interactions<br>• Optimal performance<br>• Enhanced UX |
73-
74+
| **Advanced Features** | • Copy-to-clipboard in code blocks<br>• Functional internal links<br>• SEO optimized<br>• Full accessibility | • Developer-friendly<br>• Seamless navigation<br>• Better search rankings<br>• Inclusive for all users |
75+
| **Mobile Experience** | • Collapsible menu<br>• Touch-friendly<br>• Fast loading<br>• Smooth scrolling | • Mobile-first design<br>• Intuitive interactions<br>• Optimal performance<br>• Enhanced UX |
7476

7577
## 📊 Comparison with Other Tools
7678

77-
| Feature | Knowledge | GitBook | Notion | Wiki |
78-
|---------|-----------|---------|--------|------|
79-
| **Simplicity** | ✅ Pure Markdown | ❌ Complex interface | ❌ Proprietary | ❌ Specific syntax |
80-
| **Performance** | ✅ Static sites | ⚠️ Slow loading | ⚠️ Internet dependent | ❌ Server required |
81-
| **Customization** | ✅ Themes and config | ❌ Limited | ❌ Very limited | ⚠️ Requires programming |
82-
| **Search** | ✅ Instant | ✅ Good | ✅ Good | ⚠️ Basic |
83-
| **Cost** | ✅ Free | ❌ Paid | ❌ Paid | ⚠️ Self-hosting |
84-
| **Offline** | ✅ Works | ❌ No | ❌ No | ❌ No |
85-
79+
| Feature | Documentation | GitBook | Notion | Wiki |
80+
| ----------------- | -------------------- | -------------------- | --------------------- | ----------------------- |
81+
| **Simplicity** | ✅ Pure Markdown | ❌ Complex interface | ❌ Proprietary | ❌ Specific syntax |
82+
| **Performance** | ✅ Static sites | ⚠️ Slow loading | ⚠️ Internet dependent | ❌ Server required |
83+
| **Customization** | ✅ Themes and config | ❌ Limited | ❌ Very limited | ⚠️ Requires programming |
84+
| **Search** | ✅ Instant | ✅ Good | ✅ Good | ⚠️ Basic |
85+
| **Cost** | ✅ Free | ❌ Paid | ❌ Paid | ⚠️ Self-hosting |
86+
| **Offline** | ✅ Works | ❌ No | ❌ No | ❌ No |
8687

8788
## 🏆 Benefits for Teams
8889

89-
| Team Role | Benefits | Impact |
90-
|-----------|----------|--------|
91-
| **For Developers** | • Documentation lives with the code<br>• Familiar and versionable Markdown<br>• Easy CI/CD setup<br>• No vendor lock-in | • Streamlined workflow<br>• Version control integration<br>• Automated deployments<br>• Future-proof solution |
92-
| **For Managers** | • Reduces onboarding time<br>• Improves team communication<br>• Always up-to-date documentation<br>• Zero infrastructure cost | • Faster team productivity<br>• Better collaboration<br>• Reliable information<br>• Cost-effective solution |
93-
| **For Users** | • Intuitive and fast interface<br>• Efficient search<br>• Works on any device<br>• Always available | • Enhanced user experience<br>• Quick information access<br>• Cross-platform compatibility<br>• Reliable availability |
90+
| Team Role | Benefits | Impact |
91+
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
92+
| **For Developers** | • Documentation lives with the code<br>• Familiar and versionable Markdown<br>• Easy CI/CD setup<br>• No vendor lock-in | • Streamlined workflow<br>• Version control integration<br>• Automated deployments<br>• Future-proof solution |
93+
| **For Managers** | • Reduces onboarding time<br>• Improves team communication<br>• Always up-to-date documentation<br>• Zero infrastructure cost | • Faster team productivity<br>• Better collaboration<br>• Reliable information<br>• Cost-effective solution |
94+
| **For Users** | • Intuitive and fast interface<br>• Efficient search<br>• Works on any device<br>• Always available | • Enhanced user experience<br>• Quick information access<br>• Cross-platform compatibility<br>• Reliable availability |
9495

9596
## 📈 Stats
96-
![Repo Stats](https://repobeats.axiom.co/api/embed/55571d3a82e502a0e57b6fe8c54864cd53e7e5ac.svg)
9797

98+
![Repo Stats](https://repobeats.axiom.co/api/embed/55571d3a82e502a0e57b6fe8c54864cd53e7e5ac.svg)
9899

99-
**💡 Remember**: Knowledge is made to be simple. Focus on content, let the tool handle the presentation!
100+
**💡 Remember**: Documentation is made to be simple. Focus on content, let the tool handle the presentation!

0 commit comments

Comments
 (0)