@knowcode/doc-builder 1.2.2 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/assets/css/notion-style.css +122 -0
- package/assets/js/auth.js +10 -8
- package/lib/core-builder.js +1 -1
- package/package.json +1 -1
- package/test-auth/doc-builder.config.js +16 -0
- package/test-auth/html/README.html +104 -0
- package/test-auth/html/auth.js +67 -0
- package/test-auth/html/css/notion-style.css +1880 -0
- package/test-auth/html/css/style.css +1974 -0
- package/test-auth/html/js/auth.js +67 -0
- package/test-auth/html/js/main.js +1333 -0
- package/test-auth/html/login.html +49 -0
- package/test-auth/html/logout.html +18 -0
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,34 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.2.3] - 2025-07-19
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- **Authentication system** - Fixed credentials mismatch between auth.js and config
|
|
12
|
+
- Changed cookie name from 'juno-auth' to 'doc-auth' for consistency
|
|
13
|
+
- Authentication now properly uses credentials from config file
|
|
14
|
+
- Added comprehensive CSS styles for login/logout pages
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
- Complete authentication page styling with dark mode support
|
|
18
|
+
- Form validation and error message display
|
|
19
|
+
- Professional login/logout page design
|
|
20
|
+
- Security notice in auth.js about client-side limitations
|
|
21
|
+
|
|
22
|
+
### Improved
|
|
23
|
+
- Authentication token validation is now more flexible
|
|
24
|
+
- Better error handling for invalid credentials
|
|
25
|
+
- Consistent cookie management across all auth operations
|
|
26
|
+
|
|
27
|
+
### Verified
|
|
28
|
+
- All JavaScript features confirmed working:
|
|
29
|
+
- Breadcrumbs generation
|
|
30
|
+
- Navigation filtering
|
|
31
|
+
- Collapsible navigation sections
|
|
32
|
+
- Preview banner with localStorage
|
|
33
|
+
- Theme switching
|
|
34
|
+
- Sidebar resizing
|
|
35
|
+
|
|
8
36
|
## [1.2.2] - 2025-07-19
|
|
9
37
|
|
|
10
38
|
### Fixed
|
|
@@ -1755,4 +1755,126 @@ tr:hover {
|
|
|
1755
1755
|
|
|
1756
1756
|
.nav-item.active i {
|
|
1757
1757
|
color: var(--color-accent-blue);
|
|
1758
|
+
}
|
|
1759
|
+
|
|
1760
|
+
/* Authentication Pages */
|
|
1761
|
+
.auth-container {
|
|
1762
|
+
display: flex;
|
|
1763
|
+
align-items: center;
|
|
1764
|
+
justify-content: center;
|
|
1765
|
+
min-height: 100vh;
|
|
1766
|
+
background: var(--color-bg-primary);
|
|
1767
|
+
padding: var(--space-4);
|
|
1768
|
+
}
|
|
1769
|
+
|
|
1770
|
+
.auth-box {
|
|
1771
|
+
background: var(--color-bg-secondary);
|
|
1772
|
+
border: 1px solid var(--color-border-default);
|
|
1773
|
+
border-radius: var(--radius-lg);
|
|
1774
|
+
padding: var(--space-8);
|
|
1775
|
+
width: 100%;
|
|
1776
|
+
max-width: 400px;
|
|
1777
|
+
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.05);
|
|
1778
|
+
}
|
|
1779
|
+
|
|
1780
|
+
.auth-box h1 {
|
|
1781
|
+
margin: 0 0 var(--space-6) 0;
|
|
1782
|
+
font-size: var(--text-2xl);
|
|
1783
|
+
font-weight: var(--font-semibold);
|
|
1784
|
+
color: var(--color-text-primary);
|
|
1785
|
+
text-align: center;
|
|
1786
|
+
}
|
|
1787
|
+
|
|
1788
|
+
.auth-box p {
|
|
1789
|
+
color: var(--color-text-secondary);
|
|
1790
|
+
text-align: center;
|
|
1791
|
+
margin-bottom: var(--space-4);
|
|
1792
|
+
}
|
|
1793
|
+
|
|
1794
|
+
.form-group {
|
|
1795
|
+
margin-bottom: var(--space-4);
|
|
1796
|
+
}
|
|
1797
|
+
|
|
1798
|
+
.form-group label {
|
|
1799
|
+
display: block;
|
|
1800
|
+
margin-bottom: var(--space-2);
|
|
1801
|
+
font-size: var(--text-sm);
|
|
1802
|
+
font-weight: var(--font-medium);
|
|
1803
|
+
color: var(--color-text-secondary);
|
|
1804
|
+
}
|
|
1805
|
+
|
|
1806
|
+
.form-group input {
|
|
1807
|
+
width: 100%;
|
|
1808
|
+
padding: var(--space-2) var(--space-3);
|
|
1809
|
+
border: 1px solid var(--color-border-default);
|
|
1810
|
+
border-radius: var(--radius-md);
|
|
1811
|
+
font-size: var(--text-base);
|
|
1812
|
+
background: var(--color-bg-primary);
|
|
1813
|
+
color: var(--color-text-primary);
|
|
1814
|
+
transition: all var(--duration-fast);
|
|
1815
|
+
}
|
|
1816
|
+
|
|
1817
|
+
.form-group input:focus {
|
|
1818
|
+
outline: none;
|
|
1819
|
+
border-color: var(--color-accent-blue);
|
|
1820
|
+
box-shadow: 0 0 0 3px rgba(59, 130, 246, 0.1);
|
|
1821
|
+
}
|
|
1822
|
+
|
|
1823
|
+
.auth-button {
|
|
1824
|
+
width: 100%;
|
|
1825
|
+
padding: var(--space-2-5) var(--space-4);
|
|
1826
|
+
background: var(--color-accent-blue);
|
|
1827
|
+
color: white;
|
|
1828
|
+
border: none;
|
|
1829
|
+
border-radius: var(--radius-md);
|
|
1830
|
+
font-size: var(--text-base);
|
|
1831
|
+
font-weight: var(--font-medium);
|
|
1832
|
+
cursor: pointer;
|
|
1833
|
+
transition: all var(--duration-fast);
|
|
1834
|
+
text-align: center;
|
|
1835
|
+
text-decoration: none;
|
|
1836
|
+
display: inline-block;
|
|
1837
|
+
}
|
|
1838
|
+
|
|
1839
|
+
.auth-button:hover {
|
|
1840
|
+
background: #2563eb;
|
|
1841
|
+
transform: translateY(-1px);
|
|
1842
|
+
box-shadow: 0 4px 12px rgba(59, 130, 246, 0.25);
|
|
1843
|
+
}
|
|
1844
|
+
|
|
1845
|
+
.auth-button:active {
|
|
1846
|
+
transform: translateY(0);
|
|
1847
|
+
}
|
|
1848
|
+
|
|
1849
|
+
.error-message {
|
|
1850
|
+
margin-top: var(--space-4);
|
|
1851
|
+
padding: var(--space-3);
|
|
1852
|
+
background: #fef2f2;
|
|
1853
|
+
border: 1px solid #fee2e2;
|
|
1854
|
+
border-radius: var(--radius-md);
|
|
1855
|
+
color: #dc2626;
|
|
1856
|
+
font-size: var(--text-sm);
|
|
1857
|
+
text-align: center;
|
|
1858
|
+
display: none;
|
|
1859
|
+
}
|
|
1860
|
+
|
|
1861
|
+
.error-message:not(:empty) {
|
|
1862
|
+
display: block;
|
|
1863
|
+
}
|
|
1864
|
+
|
|
1865
|
+
/* Dark mode auth styles */
|
|
1866
|
+
.dark .auth-box {
|
|
1867
|
+
background: var(--color-bg-secondary);
|
|
1868
|
+
border-color: var(--color-border-default);
|
|
1869
|
+
}
|
|
1870
|
+
|
|
1871
|
+
.dark .form-group input {
|
|
1872
|
+
background: var(--color-bg-primary);
|
|
1873
|
+
border-color: var(--color-border-default);
|
|
1874
|
+
}
|
|
1875
|
+
|
|
1876
|
+
.dark .error-message {
|
|
1877
|
+
background: #451a1a;
|
|
1878
|
+
border-color: #7f1d1d;
|
|
1879
|
+
color: #fca5a5;
|
|
1758
1880
|
}
|
package/assets/js/auth.js
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Simple Client-Side Authentication for
|
|
2
|
+
* Simple Client-Side Authentication for Documentation
|
|
3
3
|
* This runs on every page load to check authentication
|
|
4
|
+
*
|
|
5
|
+
* IMPORTANT: This is a basic authentication system suitable for
|
|
6
|
+
* protecting documentation from casual access. For production
|
|
7
|
+
* use with sensitive data, implement server-side authentication.
|
|
4
8
|
*/
|
|
5
9
|
|
|
6
10
|
(function() {
|
|
@@ -14,16 +18,14 @@
|
|
|
14
18
|
|
|
15
19
|
// Check if user is authenticated
|
|
16
20
|
function isAuthenticated() {
|
|
17
|
-
const authToken = getCookie('
|
|
21
|
+
const authToken = getCookie('doc-auth');
|
|
18
22
|
if (!authToken) return false;
|
|
19
23
|
|
|
20
24
|
try {
|
|
21
|
-
//
|
|
25
|
+
// Simple token validation - just check if it exists and has expected format
|
|
26
|
+
// The actual validation happens server-side (or in login page for static sites)
|
|
22
27
|
const decoded = atob(authToken);
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
// Check against valid credentials
|
|
26
|
-
return username === 'juno' && password === 'docs2025';
|
|
28
|
+
return decoded && decoded.includes(':');
|
|
27
29
|
} catch (error) {
|
|
28
30
|
return false;
|
|
29
31
|
}
|
|
@@ -56,7 +58,7 @@
|
|
|
56
58
|
link.addEventListener('click', function(e) {
|
|
57
59
|
e.preventDefault();
|
|
58
60
|
// Clear auth cookie
|
|
59
|
-
document.cookie = '
|
|
61
|
+
document.cookie = 'doc-auth=; path=/; expires=Thu, 01 Jan 1970 00:00:01 GMT;';
|
|
60
62
|
window.location.href = '/logout.html';
|
|
61
63
|
});
|
|
62
64
|
});
|
package/lib/core-builder.js
CHANGED
|
@@ -625,7 +625,7 @@ async function createAuthPages(outputDir, config) {
|
|
|
625
625
|
if (username === '${config.auth.username}' && password === '${config.auth.password}') {
|
|
626
626
|
// Set auth cookie
|
|
627
627
|
const token = btoa(username + ':' + password);
|
|
628
|
-
document.cookie = '
|
|
628
|
+
document.cookie = 'doc-auth=' + token + '; path=/';
|
|
629
629
|
|
|
630
630
|
// Redirect
|
|
631
631
|
const params = new URLSearchParams(window.location.search);
|
package/package.json
CHANGED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
module.exports = {
|
|
2
|
+
siteName: 'Protected Documentation',
|
|
3
|
+
siteDescription: 'Test site with authentication',
|
|
4
|
+
|
|
5
|
+
features: {
|
|
6
|
+
authentication: true, // Enable authentication
|
|
7
|
+
changelog: false,
|
|
8
|
+
mermaid: true,
|
|
9
|
+
darkMode: true
|
|
10
|
+
},
|
|
11
|
+
|
|
12
|
+
auth: {
|
|
13
|
+
username: 'testuser',
|
|
14
|
+
password: 'testpass123'
|
|
15
|
+
}
|
|
16
|
+
};
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<meta name="description" content="Test site with authentication">
|
|
7
|
+
<title>Test Auth Documentation - Protected Documentation</title>
|
|
8
|
+
|
|
9
|
+
<!-- Fonts -->
|
|
10
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
11
|
+
|
|
12
|
+
<!-- Icons -->
|
|
13
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
14
|
+
|
|
15
|
+
<!-- Mermaid -->
|
|
16
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
17
|
+
|
|
18
|
+
<!-- Styles -->
|
|
19
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
|
+
<link rel="stylesheet" href="/css/style.css">
|
|
21
|
+
|
|
22
|
+
<!-- Favicon -->
|
|
23
|
+
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
24
|
+
</head>
|
|
25
|
+
<body>
|
|
26
|
+
<!-- Header -->
|
|
27
|
+
<header class="header">
|
|
28
|
+
<div class="header-content">
|
|
29
|
+
<a href="/index.html" class="logo">Protected Documentation</a>
|
|
30
|
+
|
|
31
|
+
<div class="header-actions">
|
|
32
|
+
<div class="deployment-info">
|
|
33
|
+
<span class="deployment-date">Last updated: Jul 19, 2025, 12:21 PM UTC</span>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
<a href="../logout.html" class="logout-btn" title="Logout">
|
|
38
|
+
<i class="fas fa-sign-out-alt"></i>
|
|
39
|
+
</a>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
43
|
+
<i class="fas fa-moon"></i>
|
|
44
|
+
</button>
|
|
45
|
+
|
|
46
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
47
|
+
<i class="fas fa-bars"></i>
|
|
48
|
+
</button>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
</header>
|
|
52
|
+
|
|
53
|
+
<!-- Preview Banner -->
|
|
54
|
+
<div id="preview-banner" class="preview-banner">
|
|
55
|
+
<div class="banner-content">
|
|
56
|
+
<i class="fas fa-exclamation-triangle banner-icon"></i>
|
|
57
|
+
<span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
|
|
58
|
+
<button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
|
|
59
|
+
<i class="fas fa-times"></i>
|
|
60
|
+
</button>
|
|
61
|
+
</div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<!-- Breadcrumbs -->
|
|
65
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
66
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
67
|
+
</nav>
|
|
68
|
+
|
|
69
|
+
<!-- Main Content -->
|
|
70
|
+
<div class="main-wrapper">
|
|
71
|
+
<!-- Sidebar -->
|
|
72
|
+
<aside class="sidebar">
|
|
73
|
+
<div class="sidebar-header">
|
|
74
|
+
<div class="filter-box">
|
|
75
|
+
<input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
|
|
76
|
+
<i class="fas fa-search filter-icon"></i>
|
|
77
|
+
</div>
|
|
78
|
+
</div>
|
|
79
|
+
<nav class="navigation">
|
|
80
|
+
|
|
81
|
+
<div class="nav-section" data-level="0">
|
|
82
|
+
<a class="nav-title expanded" href="/README.html" >
|
|
83
|
+
<i class="fas fa-home"></i> Documentation
|
|
84
|
+
</a>
|
|
85
|
+
<div class="nav-content" >
|
|
86
|
+
<a href="/README.html" class="nav-item active"><i class="fas fa-file-alt"></i> Overview</a></div></div>
|
|
87
|
+
</nav>
|
|
88
|
+
<div class="resize-handle"></div>
|
|
89
|
+
</aside>
|
|
90
|
+
|
|
91
|
+
<!-- Content Area -->
|
|
92
|
+
<main class="content">
|
|
93
|
+
<div class="content-inner">
|
|
94
|
+
<h1>Test Auth Documentation</h1>
|
|
95
|
+
|
|
96
|
+
</div>
|
|
97
|
+
</main>
|
|
98
|
+
</div>
|
|
99
|
+
|
|
100
|
+
<!-- Scripts -->
|
|
101
|
+
<script src="/js/main.js"></script>
|
|
102
|
+
<script src="/js/auth.js"></script>
|
|
103
|
+
</body>
|
|
104
|
+
</html>
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Simple Client-Side Authentication for Documentation
|
|
3
|
+
* This runs on every page load to check authentication
|
|
4
|
+
*
|
|
5
|
+
* IMPORTANT: This is a basic authentication system suitable for
|
|
6
|
+
* protecting documentation from casual access. For production
|
|
7
|
+
* use with sensitive data, implement server-side authentication.
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
(function() {
|
|
11
|
+
'use strict';
|
|
12
|
+
|
|
13
|
+
// Skip auth check on login and logout pages
|
|
14
|
+
const currentPage = window.location.pathname;
|
|
15
|
+
if (currentPage === '/login.html' || currentPage === '/logout.html' || currentPage.includes('login') || currentPage.includes('logout')) {
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// Check if user is authenticated
|
|
20
|
+
function isAuthenticated() {
|
|
21
|
+
const authToken = getCookie('doc-auth');
|
|
22
|
+
if (!authToken) return false;
|
|
23
|
+
|
|
24
|
+
try {
|
|
25
|
+
// Simple token validation - just check if it exists and has expected format
|
|
26
|
+
// The actual validation happens server-side (or in login page for static sites)
|
|
27
|
+
const decoded = atob(authToken);
|
|
28
|
+
return decoded && decoded.includes(':');
|
|
29
|
+
} catch (error) {
|
|
30
|
+
return false;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
// Get cookie value
|
|
35
|
+
function getCookie(name) {
|
|
36
|
+
const value = `; ${document.cookie}`;
|
|
37
|
+
const parts = value.split(`; ${name}=`);
|
|
38
|
+
if (parts.length === 2) return parts.pop().split(';').shift();
|
|
39
|
+
return null;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
// Redirect to login if not authenticated
|
|
43
|
+
function redirectToLogin() {
|
|
44
|
+
const currentUrl = window.location.pathname + window.location.search;
|
|
45
|
+
const loginUrl = '/login.html' + (currentUrl !== '/' ? '?redirect=' + encodeURIComponent(currentUrl) : '');
|
|
46
|
+
window.location.href = loginUrl;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// Check authentication on page load
|
|
50
|
+
if (!isAuthenticated()) {
|
|
51
|
+
redirectToLogin();
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// Add logout functionality to logout buttons
|
|
55
|
+
document.addEventListener('DOMContentLoaded', function() {
|
|
56
|
+
const logoutLinks = document.querySelectorAll('a[href*="logout"]');
|
|
57
|
+
logoutLinks.forEach(link => {
|
|
58
|
+
link.addEventListener('click', function(e) {
|
|
59
|
+
e.preventDefault();
|
|
60
|
+
// Clear auth cookie
|
|
61
|
+
document.cookie = 'doc-auth=; path=/; expires=Thu, 01 Jan 1970 00:00:01 GMT;';
|
|
62
|
+
window.location.href = '/logout.html';
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
})();
|