create-specment 0.2.9 → 0.3.0

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.
Files changed (133) hide show
  1. package/bin/commands/create.d.ts +0 -1
  2. package/bin/constants/languages.d.ts +0 -1
  3. package/bin/core/interactive-setup.d.ts +0 -1
  4. package/bin/core/interactive-setup.js +17 -10
  5. package/bin/core/interactive-setup.js.map +1 -1
  6. package/bin/core/interactive-setup.test.d.ts +0 -1
  7. package/bin/core/interactive-setup.test.js +7 -7
  8. package/bin/core/interactive-setup.test.js.map +1 -1
  9. package/bin/core/project-generator.d.ts +0 -1
  10. package/bin/core/project-generator.js +5 -8
  11. package/bin/core/project-generator.js.map +1 -1
  12. package/bin/features/index.d.ts +0 -1
  13. package/bin/features/index.js +15 -13
  14. package/bin/features/index.js.map +1 -1
  15. package/bin/generators/docusaurus-config.d.ts +0 -1
  16. package/bin/generators/docusaurus-config.js +211 -264
  17. package/bin/generators/docusaurus-config.js.map +1 -1
  18. package/bin/generators/package-json.d.ts +0 -1
  19. package/bin/generators/package-json.js +45 -91
  20. package/bin/generators/package-json.js.map +1 -1
  21. package/bin/generators/template-files.d.ts +0 -1
  22. package/bin/generators/template-files.js +563 -168
  23. package/bin/generators/template-files.js.map +1 -1
  24. package/bin/index.d.ts +0 -1
  25. package/bin/index.js.map +1 -1
  26. package/bin/templates/index.d.ts +0 -1
  27. package/bin/templates/index.js +36 -24
  28. package/bin/templates/index.js.map +1 -1
  29. package/bin/tests/integration.test.d.ts +0 -1
  30. package/bin/tests/integration.test.js +34 -34
  31. package/bin/tests/integration.test.js.map +1 -1
  32. package/bin/types/index.d.ts +1 -21
  33. package/bin/utils/config-merger.d.ts +0 -1
  34. package/bin/utils/config-merger.js +0 -1
  35. package/bin/utils/config-merger.js.map +1 -1
  36. package/bin/utils/errors.d.ts +0 -1
  37. package/bin/utils/install.d.ts +0 -1
  38. package/bin/utils/install.js +3 -3
  39. package/bin/utils/install.js.map +1 -1
  40. package/bin/utils/message-formatter.d.ts +0 -1
  41. package/bin/utils/template-processor.d.ts +0 -1
  42. package/bin/utils/template-processor.js +2 -3
  43. package/bin/utils/template-processor.js.map +1 -1
  44. package/bin/utils/template-processor.test.d.ts +0 -1
  45. package/bin/utils/template-processor.test.js +22 -22
  46. package/bin/utils/template-processor.test.js.map +1 -1
  47. package/bin/utils/version.d.ts +0 -1
  48. package/bin/utils/version.js +3 -3
  49. package/bin/utils/version.js.map +1 -1
  50. package/package.json +2 -7
  51. package/templates/docs/01-overview/_requirements-specification.mdx +1 -5
  52. package/templates/docs/01-overview/as-is.mdx +1 -1
  53. package/templates/docs/01-overview/glossary.mdx +6 -6
  54. package/templates/docs/01-overview/odsc.mdx +1 -1
  55. package/templates/docs/01-overview/to-be.mdx +6 -6
  56. package/templates/docs/02-requirements/functional/_req-template.mdx +0 -3
  57. package/templates/docs/02-requirements/functional/req-001.mdx +0 -4
  58. package/templates/docs/02-requirements/non-functional/_nfr-template.mdx +0 -3
  59. package/templates/docs/02-requirements/non-functional/nfr-001.mdx +0 -3
  60. package/templates/docs/02-requirements/non-functional/nfr-002.mdx +0 -3
  61. package/templates/docs/03-external/business-model.mdx +1 -1
  62. package/templates/docs/03-external/index.mdx +1 -1
  63. package/templates/docs/04-internal/batches/import-products.mdx +2 -6
  64. package/templates/docs/04-internal/policies/github.mdx +1 -1
  65. package/templates/docs/04-internal/rules/database.mdx +1 -1
  66. package/templates/docs/04-internal/screens/dashboard.mdx +1 -1
  67. package/templates/docs/04-internal/screens/index.mdx +1 -1
  68. package/templates/docs/04-internal/screens/login.mdx +1 -1
  69. package/templates/docs/04-internal/screens/menu.mdx +1 -1
  70. package/templates/docs/index.module.css +96 -0
  71. package/templates/docs/index.tsx +48 -0
  72. package/templates/docs/introduction/index.mdx +1 -1
  73. package/templates/docs/introduction/operational-policies/sharepoint.mdx +1 -1
  74. package/templates/package.json.template +46 -0
  75. package/templates/src/components/Highlight/index.tsx +68 -0
  76. package/templates/src/components/PriorityMatrix/index.tsx +97 -0
  77. package/templates/src/components/TBD/index.tsx +16 -0
  78. package/templates/src/css/custom.css +81 -0
  79. package/templates/src/types/requirements.ts +19 -0
  80. package/templates/static/img/business-model.drawio.svg +4 -0
  81. package/templates/static/img/gantt.drawio.svg +1152 -0
  82. package/templates/static/img/logo.svg +21 -0
  83. package/bin/commands/create.d.ts.map +0 -1
  84. package/bin/constants/languages.d.ts.map +0 -1
  85. package/bin/core/interactive-setup.d.ts.map +0 -1
  86. package/bin/core/interactive-setup.test.d.ts.map +0 -1
  87. package/bin/core/project-generator.d.ts.map +0 -1
  88. package/bin/features/index.d.ts.map +0 -1
  89. package/bin/generators/docusaurus-config.d.ts.map +0 -1
  90. package/bin/generators/package-json.d.ts.map +0 -1
  91. package/bin/generators/template-files.d.ts.map +0 -1
  92. package/bin/index.d.ts.map +0 -1
  93. package/bin/plugins/i18n-integration.d.ts +0 -25
  94. package/bin/plugins/i18n-integration.d.ts.map +0 -1
  95. package/bin/plugins/i18n-integration.js +0 -310
  96. package/bin/plugins/i18n-integration.js.map +0 -1
  97. package/bin/plugins/plantuml-integration.d.ts +0 -17
  98. package/bin/plugins/plantuml-integration.d.ts.map +0 -1
  99. package/bin/plugins/plantuml-integration.js +0 -112
  100. package/bin/plugins/plantuml-integration.js.map +0 -1
  101. package/bin/plugins/redoc-integration.d.ts +0 -25
  102. package/bin/plugins/redoc-integration.d.ts.map +0 -1
  103. package/bin/plugins/redoc-integration.js +0 -373
  104. package/bin/plugins/redoc-integration.js.map +0 -1
  105. package/bin/plugins/search-integration.d.ts +0 -20
  106. package/bin/plugins/search-integration.d.ts.map +0 -1
  107. package/bin/plugins/search-integration.js +0 -169
  108. package/bin/plugins/search-integration.js.map +0 -1
  109. package/bin/templates/index.d.ts.map +0 -1
  110. package/bin/templates/template-definitions.d.ts +0 -10
  111. package/bin/templates/template-definitions.d.ts.map +0 -1
  112. package/bin/templates/template-definitions.js +0 -517
  113. package/bin/templates/template-definitions.js.map +0 -1
  114. package/bin/tests/integration.test.d.ts.map +0 -1
  115. package/bin/types/index.d.ts.map +0 -1
  116. package/bin/utils/config-merger.d.ts.map +0 -1
  117. package/bin/utils/errors.d.ts.map +0 -1
  118. package/bin/utils/install.d.ts.map +0 -1
  119. package/bin/utils/message-formatter.d.ts.map +0 -1
  120. package/bin/utils/template-processor.d.ts.map +0 -1
  121. package/bin/utils/template-processor.test.d.ts.map +0 -1
  122. package/bin/utils/version.d.ts.map +0 -1
  123. package/templates/classic-spec/docusaurus.config.js.template +0 -106
  124. package/templates/classic-spec/package.json.template +0 -36
  125. package/templates/docs/example.drawio.svg +0 -57
  126. package/templates/external-design/docusaurus.config.js.template +0 -123
  127. package/templates/external-design/package.json.template +0 -36
  128. package/templates/internal-design/docusaurus.config.js.template +0 -123
  129. package/templates/internal-design/package.json.template +0 -36
  130. package/templates/project-analysis/docusaurus.config.js.template +0 -113
  131. package/templates/project-analysis/package.json.template +0 -36
  132. package/templates/requirements/docusaurus.config.js.template +0 -119
  133. package/templates/requirements/package.json.template +0 -36
@@ -1,36 +0,0 @@
1
- {
2
- "name": "{{projectName}}",
3
- "version": "0.0.0",
4
- "private": true,
5
- "scripts": {
6
- "docusaurus": "docusaurus",
7
- "start": "docusaurus start",
8
- "build": "docusaurus build",
9
- "swizzle": "docusaurus swizzle",
10
- "deploy": "docusaurus deploy",
11
- "clear": "docusaurus clear",
12
- "serve": "docusaurus serve",
13
- "write-translations": "docusaurus write-translations",
14
- "write-heading-ids": "docusaurus write-heading-ids"
15
- },
16
- "dependencies": {
17
- "@docusaurus/core": "^3.0.0",
18
- "@docusaurus/preset-classic": "^3.0.0",
19
- "@mdx-js/react": "^3.0.0",
20
- "clsx": "^2.0.0",
21
- "prism-react-renderer": "^2.3.0",
22
- "react": "^18.0.0",
23
- "react-dom": "^18.0.0"
24
- },
25
- "devDependencies": {
26
- "@docusaurus/module-type-aliases": "^3.0.0",
27
- "@docusaurus/types": "^3.0.0"
28
- },
29
- "browserslist": {
30
- "production": [">0.5%", "not dead", "not op_mini all"],
31
- "development": ["last 3 chrome version", "last 3 firefox version", "last 5 safari version"]
32
- },
33
- "engines": {
34
- "node": ">=20.0"
35
- }
36
- }
@@ -1,57 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <svg width="850" height="300" xmlns="http://www.w3.org/2000/svg" font-family="Arial, sans-serif">
3
- <!-- 定義: 矢印マーカー -->
4
- <defs>
5
- <marker id="arrow" markerWidth="10" markerHeight="10" refX="10" refY="5" orient="auto">
6
- <path d="M0,0 L10,5 L0,10 Z" fill="black" />
7
- </marker>
8
- </defs>
9
-
10
- <!-- コンポーネント: User -->
11
- <rect x="40" y="40" width="80" height="40" fill="#FFFFFF" stroke="#000000" />
12
- <text x="80" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">User</text>
13
-
14
- <!-- コンポーネント: Amazon Route 53 -->
15
- <rect x="180" y="40" width="120" height="40" fill="#F9E79F" stroke="#F1C40F" />
16
- <text x="240" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon Route 53</text>
17
-
18
- <!-- コンポーネント: Amazon CloudFront -->
19
- <rect x="330" y="40" width="120" height="40" fill="#D1F2EB" stroke="#1ABC9C" />
20
- <text x="390" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon CloudFront</text>
21
-
22
- <!-- コンポーネント: Elastic Load Balancer -->
23
- <rect x="480" y="40" width="140" height="40" fill="#F5B7B1" stroke="#E74C3C" />
24
- <text x="550" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">Elastic Load Balancer</text>
25
-
26
- <!-- コンポーネント: EC2 (Auto Scaling) -->
27
- <rect x="650" y="40" width="140" height="60" fill="#D6EAF8" stroke="#3498DB" />
28
- <text x="720" y="70" text-anchor="middle" dominant-baseline="middle" font-size="12">EC2 (Auto Scaling)</text>
29
-
30
- <!-- コンポーネント: Amazon RDS -->
31
- <rect x="650" y="120" width="140" height="60" fill="#E8DAEF" stroke="#8E44AD" />
32
- <text x="720" y="150" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon RDS</text>
33
-
34
- <!-- コンポーネント: Amazon S3 -->
35
- <rect x="650" y="200" width="140" height="60" fill="#FCF3CF" stroke="#F4D03F" />
36
- <text x="720" y="230" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon S3</text>
37
-
38
- <!-- 接続エッジ -->
39
-
40
- <!-- User -> Amazon Route 53 -->
41
- <line x1="120" y1="60" x2="180" y2="60" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
42
-
43
- <!-- Amazon Route 53 -> Amazon CloudFront -->
44
- <line x1="300" y1="60" x2="330" y2="60" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
45
-
46
- <!-- Amazon CloudFront -> Elastic Load Balancer -->
47
- <line x1="450" y1="60" x2="480" y2="60" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
48
-
49
- <!-- Elastic Load Balancer -> EC2 (Auto Scaling) -->
50
- <line x1="620" y1="60" x2="650" y2="70" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
51
-
52
- <!-- EC2 (Auto Scaling) -> Amazon RDS -->
53
- <line x1="670" y1="100" x2="720" y2="120" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
54
-
55
- <!-- EC2 (Auto Scaling) -> Amazon S3 -->
56
- <line x1="770" y1="100" x2="720" y2="200" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
57
- </svg>
@@ -1,123 +0,0 @@
1
- // @ts-check
2
- // Note: type annotations allow type checking and IDEs autocompletion
3
-
4
- /** @type {import('@docusaurus/types').Config} */
5
- const config = {
6
- title: '{{projectName}}',
7
- tagline: 'External Design Specification Documentation',
8
- favicon: 'img/favicon.ico',
9
-
10
- // Set the production url of your site here
11
- url: 'https://your-docusaurus-site.example.com',
12
- // Set the /<baseUrl>/ pathname under which your site is served
13
- baseUrl: '/',
14
-
15
- // GitHub pages deployment config.
16
- organizationName: 'your-org',
17
- projectName: '{{projectName}}',
18
-
19
- onBrokenLinks: 'throw',
20
- onBrokenMarkdownLinks: 'warn',
21
-
22
- // Even if you don't use internalization, you can use this field to set useful
23
- // metadata like html lang. For example, if your site is Chinese, you may want
24
- // to replace "en" with "zh-Hans".
25
- i18n: {
26
- defaultLocale: 'en',
27
- locales: ['en'],
28
- },
29
-
30
- presets: [
31
- [
32
- 'classic',
33
- /** @type {import('@docusaurus/preset-classic').Options} */
34
- ({
35
- docs: {
36
- sidebarPath: require.resolve('./sidebars.js'),
37
- editUrl: 'https://github.com/your-org/your-repo/tree/main/',
38
- },
39
- blog: false, // Disable blog for external design
40
- theme: {
41
- customCss: require.resolve('./src/css/custom.css'),
42
- },
43
- }),
44
- ],
45
- ],
46
-
47
- themeConfig:
48
- /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
49
- ({
50
- // Replace with your project's social card
51
- image: 'img/docusaurus-social-card.jpg',
52
- navbar: {
53
- title: '{{projectName}}',
54
- logo: {
55
- alt: '{{projectName}} Logo',
56
- src: 'img/logo.svg',
57
- },
58
- items: [
59
- {
60
- type: 'docSidebar',
61
- sidebarId: 'architectureSidebar',
62
- position: 'left',
63
- label: 'Architecture',
64
- },
65
- {
66
- type: 'docSidebar',
67
- sidebarId: 'apiSidebar',
68
- position: 'left',
69
- label: 'API Design',
70
- },
71
- {
72
- type: 'docSidebar',
73
- sidebarId: 'uiSidebar',
74
- position: 'left',
75
- label: 'UI/UX Design',
76
- },
77
- {
78
- href: 'https://github.com/your-org/your-repo',
79
- label: 'GitHub',
80
- position: 'right',
81
- },
82
- ],
83
- },
84
- footer: {
85
- style: 'dark',
86
- links: [
87
- {
88
- title: 'Design',
89
- items: [
90
- {
91
- label: 'System Architecture',
92
- to: '/docs/architecture/intro',
93
- },
94
- {
95
- label: 'API Design',
96
- to: '/docs/api/intro',
97
- },
98
- {
99
- label: 'UI/UX Design',
100
- to: '/docs/ui/intro',
101
- },
102
- ],
103
- },
104
- {
105
- title: 'Community',
106
- items: [
107
- {
108
- label: 'GitHub',
109
- href: 'https://github.com/your-org/your-repo',
110
- },
111
- ],
112
- },
113
- ],
114
- copyright: `Copyright © ${new Date().getFullYear()} {{projectName}}. Built with Docusaurus.`,
115
- },
116
- prism: {
117
- theme: require('prism-react-renderer/themes/github'),
118
- darkTheme: require('prism-react-renderer/themes/dracula'),
119
- },
120
- }),
121
- };
122
-
123
- module.exports = config;
@@ -1,36 +0,0 @@
1
- {
2
- "name": "{{projectName}}",
3
- "version": "0.0.0",
4
- "private": true,
5
- "scripts": {
6
- "docusaurus": "docusaurus",
7
- "start": "docusaurus start",
8
- "build": "docusaurus build",
9
- "swizzle": "docusaurus swizzle",
10
- "deploy": "docusaurus deploy",
11
- "clear": "docusaurus clear",
12
- "serve": "docusaurus serve",
13
- "write-translations": "docusaurus write-translations",
14
- "write-heading-ids": "docusaurus write-heading-ids"
15
- },
16
- "dependencies": {
17
- "@docusaurus/core": "^3.0.0",
18
- "@docusaurus/preset-classic": "^3.0.0",
19
- "@mdx-js/react": "^3.0.0",
20
- "clsx": "^2.0.0",
21
- "prism-react-renderer": "^2.3.0",
22
- "react": "^18.0.0",
23
- "react-dom": "^18.0.0"
24
- },
25
- "devDependencies": {
26
- "@docusaurus/module-type-aliases": "^3.0.0",
27
- "@docusaurus/types": "^3.0.0"
28
- },
29
- "browserslist": {
30
- "production": [">0.5%", "not dead", "not op_mini all"],
31
- "development": ["last 3 chrome version", "last 3 firefox version", "last 5 safari version"]
32
- },
33
- "engines": {
34
- "node": ">=20.0"
35
- }
36
- }
@@ -1,123 +0,0 @@
1
- // @ts-check
2
- // Note: type annotations allow type checking and IDEs autocompletion
3
-
4
- /** @type {import('@docusaurus/types').Config} */
5
- const config = {
6
- title: '{{projectName}}',
7
- tagline: 'Internal Design Specification Documentation',
8
- favicon: 'img/favicon.ico',
9
-
10
- // Set the production url of your site here
11
- url: 'https://your-docusaurus-site.example.com',
12
- // Set the /<baseUrl>/ pathname under which your site is served
13
- baseUrl: '/',
14
-
15
- // GitHub pages deployment config.
16
- organizationName: 'your-org',
17
- projectName: '{{projectName}}',
18
-
19
- onBrokenLinks: 'throw',
20
- onBrokenMarkdownLinks: 'warn',
21
-
22
- // Even if you don't use internalization, you can use this field to set useful
23
- // metadata like html lang. For example, if your site is Chinese, you may want
24
- // to replace "en" with "zh-Hans".
25
- i18n: {
26
- defaultLocale: 'en',
27
- locales: ['en'],
28
- },
29
-
30
- presets: [
31
- [
32
- 'classic',
33
- /** @type {import('@docusaurus/preset-classic').Options} */
34
- ({
35
- docs: {
36
- sidebarPath: require.resolve('./sidebars.js'),
37
- editUrl: 'https://github.com/your-org/your-repo/tree/main/',
38
- },
39
- blog: false, // Disable blog for internal design
40
- theme: {
41
- customCss: require.resolve('./src/css/custom.css'),
42
- },
43
- }),
44
- ],
45
- ],
46
-
47
- themeConfig:
48
- /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
49
- ({
50
- // Replace with your project's social card
51
- image: 'img/docusaurus-social-card.jpg',
52
- navbar: {
53
- title: '{{projectName}}',
54
- logo: {
55
- alt: '{{projectName}} Logo',
56
- src: 'img/logo.svg',
57
- },
58
- items: [
59
- {
60
- type: 'docSidebar',
61
- sidebarId: 'implementationSidebar',
62
- position: 'left',
63
- label: 'Implementation',
64
- },
65
- {
66
- type: 'docSidebar',
67
- sidebarId: 'databaseSidebar',
68
- position: 'left',
69
- label: 'Database Design',
70
- },
71
- {
72
- type: 'docSidebar',
73
- sidebarId: 'algorithmSidebar',
74
- position: 'left',
75
- label: 'Algorithms',
76
- },
77
- {
78
- href: 'https://github.com/your-org/your-repo',
79
- label: 'GitHub',
80
- position: 'right',
81
- },
82
- ],
83
- },
84
- footer: {
85
- style: 'dark',
86
- links: [
87
- {
88
- title: 'Internal Design',
89
- items: [
90
- {
91
- label: 'Implementation Details',
92
- to: '/docs/implementation/intro',
93
- },
94
- {
95
- label: 'Database Design',
96
- to: '/docs/database/intro',
97
- },
98
- {
99
- label: 'Algorithms',
100
- to: '/docs/algorithms/intro',
101
- },
102
- ],
103
- },
104
- {
105
- title: 'Community',
106
- items: [
107
- {
108
- label: 'GitHub',
109
- href: 'https://github.com/your-org/your-repo',
110
- },
111
- ],
112
- },
113
- ],
114
- copyright: `Copyright © ${new Date().getFullYear()} {{projectName}}. Built with Docusaurus.`,
115
- },
116
- prism: {
117
- theme: require('prism-react-renderer/themes/github'),
118
- darkTheme: require('prism-react-renderer/themes/dracula'),
119
- },
120
- }),
121
- };
122
-
123
- module.exports = config;
@@ -1,36 +0,0 @@
1
- {
2
- "name": "{{projectName}}",
3
- "version": "0.0.0",
4
- "private": true,
5
- "scripts": {
6
- "docusaurus": "docusaurus",
7
- "start": "docusaurus start",
8
- "build": "docusaurus build",
9
- "swizzle": "docusaurus swizzle",
10
- "deploy": "docusaurus deploy",
11
- "clear": "docusaurus clear",
12
- "serve": "docusaurus serve",
13
- "write-translations": "docusaurus write-translations",
14
- "write-heading-ids": "docusaurus write-heading-ids"
15
- },
16
- "dependencies": {
17
- "@docusaurus/core": "^3.0.0",
18
- "@docusaurus/preset-classic": "^3.0.0",
19
- "@mdx-js/react": "^3.0.0",
20
- "clsx": "^2.0.0",
21
- "prism-react-renderer": "^2.3.0",
22
- "react": "^18.0.0",
23
- "react-dom": "^18.0.0"
24
- },
25
- "devDependencies": {
26
- "@docusaurus/module-type-aliases": "^3.0.0",
27
- "@docusaurus/types": "^3.0.0"
28
- },
29
- "browserslist": {
30
- "production": [">0.5%", "not dead", "not op_mini all"],
31
- "development": ["last 3 chrome version", "last 3 firefox version", "last 5 safari version"]
32
- },
33
- "engines": {
34
- "node": ">=20.0"
35
- }
36
- }
@@ -1,113 +0,0 @@
1
- // @ts-check
2
- // Note: type annotations allow type checking and IDEs autocompletion
3
-
4
- /** @type {import('@docusaurus/types').Config} */
5
- const config = {
6
- title: '{{projectName}}',
7
- tagline: 'Project Analysis & Overview Documentation',
8
- favicon: 'img/favicon.ico',
9
-
10
- // Set the production url of your site here
11
- url: 'https://your-docusaurus-site.example.com',
12
- // Set the /<baseUrl>/ pathname under which your site is served
13
- baseUrl: '/',
14
-
15
- // GitHub pages deployment config.
16
- organizationName: 'your-org',
17
- projectName: '{{projectName}}',
18
-
19
- onBrokenLinks: 'throw',
20
- onBrokenMarkdownLinks: 'warn',
21
-
22
- // Even if you don't use internalization, you can use this field to set useful
23
- // metadata like html lang. For example, if your site is Chinese, you may want
24
- // to replace "en" with "zh-Hans".
25
- i18n: {
26
- defaultLocale: 'en',
27
- locales: ['en'],
28
- },
29
-
30
- presets: [
31
- [
32
- 'classic',
33
- /** @type {import('@docusaurus/preset-classic').Options} */
34
- ({
35
- docs: {
36
- sidebarPath: require.resolve('./sidebars.js'),
37
- editUrl: 'https://github.com/your-org/your-repo/tree/main/',
38
- },
39
- blog: false, // Disable blog for project analysis
40
- theme: {
41
- customCss: require.resolve('./src/css/custom.css'),
42
- },
43
- }),
44
- ],
45
- ],
46
-
47
- themeConfig:
48
- /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
49
- ({
50
- // Replace with your project's social card
51
- image: 'img/docusaurus-social-card.jpg',
52
- navbar: {
53
- title: '{{projectName}}',
54
- logo: {
55
- alt: '{{projectName}} Logo',
56
- src: 'img/logo.svg',
57
- },
58
- items: [
59
- {
60
- type: 'docSidebar',
61
- sidebarId: 'analysisSidebar',
62
- position: 'left',
63
- label: 'Project Analysis',
64
- },
65
- {
66
- type: 'docSidebar',
67
- sidebarId: 'overviewSidebar',
68
- position: 'left',
69
- label: 'Overview',
70
- },
71
- {
72
- href: 'https://github.com/your-org/your-repo',
73
- label: 'GitHub',
74
- position: 'right',
75
- },
76
- ],
77
- },
78
- footer: {
79
- style: 'dark',
80
- links: [
81
- {
82
- title: 'Documentation',
83
- items: [
84
- {
85
- label: 'Project Analysis',
86
- to: '/docs/analysis/intro',
87
- },
88
- {
89
- label: 'Overview',
90
- to: '/docs/overview/intro',
91
- },
92
- ],
93
- },
94
- {
95
- title: 'Community',
96
- items: [
97
- {
98
- label: 'GitHub',
99
- href: 'https://github.com/your-org/your-repo',
100
- },
101
- ],
102
- },
103
- ],
104
- copyright: `Copyright © ${new Date().getFullYear()} {{projectName}}. Built with Docusaurus.`,
105
- },
106
- prism: {
107
- theme: require('prism-react-renderer/themes/github'),
108
- darkTheme: require('prism-react-renderer/themes/dracula'),
109
- },
110
- }),
111
- };
112
-
113
- module.exports = config;
@@ -1,36 +0,0 @@
1
- {
2
- "name": "{{projectName}}",
3
- "version": "0.0.0",
4
- "private": true,
5
- "scripts": {
6
- "docusaurus": "docusaurus",
7
- "start": "docusaurus start",
8
- "build": "docusaurus build",
9
- "swizzle": "docusaurus swizzle",
10
- "deploy": "docusaurus deploy",
11
- "clear": "docusaurus clear",
12
- "serve": "docusaurus serve",
13
- "write-translations": "docusaurus write-translations",
14
- "write-heading-ids": "docusaurus write-heading-ids"
15
- },
16
- "dependencies": {
17
- "@docusaurus/core": "^3.0.0",
18
- "@docusaurus/preset-classic": "^3.0.0",
19
- "@mdx-js/react": "^3.0.0",
20
- "clsx": "^2.0.0",
21
- "prism-react-renderer": "^2.3.0",
22
- "react": "^18.0.0",
23
- "react-dom": "^18.0.0"
24
- },
25
- "devDependencies": {
26
- "@docusaurus/module-type-aliases": "^3.0.0",
27
- "@docusaurus/types": "^3.0.0"
28
- },
29
- "browserslist": {
30
- "production": [">0.5%", "not dead", "not op_mini all"],
31
- "development": ["last 3 chrome version", "last 3 firefox version", "last 5 safari version"]
32
- },
33
- "engines": {
34
- "node": ">=20.0"
35
- }
36
- }
@@ -1,119 +0,0 @@
1
- // @ts-check
2
- // Note: type annotations allow type checking and IDEs autocompletion
3
-
4
- /** @type {import('@docusaurus/types').Config} */
5
- const config = {
6
- title: '{{projectName}}',
7
- tagline: 'Requirements Specification Documentation',
8
- favicon: 'img/favicon.ico',
9
-
10
- // Set the production url of your site here
11
- url: 'https://your-docusaurus-site.example.com',
12
- // Set the /<baseUrl>/ pathname under which your site is served
13
- baseUrl: '/',
14
-
15
- // GitHub pages deployment config.
16
- organizationName: 'your-org',
17
- projectName: '{{projectName}}',
18
-
19
- onBrokenLinks: 'throw',
20
- onBrokenMarkdownLinks: 'warn',
21
-
22
- // Even if you don't use internalization, you can use this field to set useful
23
- // metadata like html lang. For example, if your site is Chinese, you may want
24
- // to replace "en" with "zh-Hans".
25
- i18n: {
26
- defaultLocale: 'en',
27
- locales: ['en'],
28
- },
29
-
30
- presets: [
31
- [
32
- 'classic',
33
- /** @type {import('@docusaurus/preset-classic').Options} */
34
- ({
35
- docs: {
36
- sidebarPath: require.resolve('./sidebars.js'),
37
- editUrl: 'https://github.com/your-org/your-repo/tree/main/',
38
- },
39
- blog: false, // Disable blog for requirements
40
- theme: {
41
- customCss: require.resolve('./src/css/custom.css'),
42
- },
43
- }),
44
- ],
45
- ],
46
-
47
- themeConfig:
48
- /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
49
- ({
50
- // Replace with your project's social card
51
- image: 'img/docusaurus-social-card.jpg',
52
- navbar: {
53
- title: '{{projectName}}',
54
- logo: {
55
- alt: '{{projectName}} Logo',
56
- src: 'img/logo.svg',
57
- },
58
- items: [
59
- {
60
- type: 'docSidebar',
61
- sidebarId: 'requirementsSidebar',
62
- position: 'left',
63
- label: 'Requirements',
64
- },
65
- {
66
- type: 'docSidebar',
67
- sidebarId: 'functionalSidebar',
68
- position: 'left',
69
- label: 'Functional',
70
- },
71
- {
72
- type: 'docSidebar',
73
- sidebarId: 'nonFunctionalSidebar',
74
- position: 'left',
75
- label: 'Non-Functional',
76
- },
77
- {
78
- href: 'https://github.com/your-org/your-repo',
79
- label: 'GitHub',
80
- position: 'right',
81
- },
82
- ],
83
- },
84
- footer: {
85
- style: 'dark',
86
- links: [
87
- {
88
- title: 'Requirements',
89
- items: [
90
- {
91
- label: 'Functional Requirements',
92
- to: '/docs/functional/intro',
93
- },
94
- {
95
- label: 'Non-Functional Requirements',
96
- to: '/docs/non-functional/intro',
97
- },
98
- ],
99
- },
100
- {
101
- title: 'Community',
102
- items: [
103
- {
104
- label: 'GitHub',
105
- href: 'https://github.com/your-org/your-repo',
106
- },
107
- ],
108
- },
109
- ],
110
- copyright: `Copyright © ${new Date().getFullYear()} {{projectName}}. Built with Docusaurus.`,
111
- },
112
- prism: {
113
- theme: require('prism-react-renderer/themes/github'),
114
- darkTheme: require('prism-react-renderer/themes/dracula'),
115
- },
116
- }),
117
- };
118
-
119
- module.exports = config;