Skip to content

Commit 90fd4e8

Browse files
dev-docs-github-app-dev[bot]dev-docs-github-app-dev[bot]
authored
Update file
1 parent d694660 commit 90fd4e8

File tree

1 file changed

+47
-128
lines changed

1 file changed

+47
-128
lines changed

‎package.json‎

Lines changed: 47 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,47 @@
1-
{
2-
"name": "my-website",
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-
"migrate": "node migrate.js",
14-
"write-translations": "docusaurus write-translations",
15-
"write-heading-ids": "docusaurus write-heading-ids",
16-
"devdocs-pft": "git merge template/main --allow-unrelated-histories",
17-
"devdocs-rc": "git checkout --theirs .",
18-
"typecheck": "tsc"
19-
},
20-
"dependencies": {
21-
"@docusaurus/core": "^3.5.2",
22-
"@docusaurus/plugin-content-docs": "^3.5.2",
23-
"@docusaurus/preset-classic": "^3.5.2",
24-
"@docusaurus/theme-live-codeblock": "^3.5.2",
25-
"@fontsource/inter": "^5.1.0",
26-
"@gocapsule/column-extension": "^1.0.0-beta-3",
27-
"@mdx-js/react": "^3.0.1",
28-
"@monaco-editor/react": "^4.6.0",
29-
"@orama/plugin-docusaurus-v3": "2.0.19",
30-
"@orama/searchbox": "1.0.0-rc33",
31-
"@radix-ui/react-accordion": "^1.1.2",
32-
"@radix-ui/react-alert-dialog": "^1.1.1",
33-
"@radix-ui/react-aspect-ratio": "^1.0.3",
34-
"@radix-ui/react-context-menu": "^2.1.5",
35-
"@radix-ui/react-icons": "^1.3.0",
36-
"@radix-ui/react-separator": "^1.0.3",
37-
"@radix-ui/react-slot": "^1.1.0",
38-
"@radix-ui/react-tabs": "^1.1.0",
39-
"@react-three/fiber": "^8.17.7",
40-
"@tabler/icons-react": "^3.16.0",
41-
"@tailwindcss/aspect-ratio": "^0.4.2",
42-
"@tanstack/react-table": "^8.10.7",
43-
"@tiptap/core": "^2.6.6",
44-
"@tiptap/extension-code-block-lowlight": "^2.6.6",
45-
"@tiptap/extension-color": "^2.6.6",
46-
"@tiptap/extension-image": "^2.6.6",
47-
"@tiptap/extension-link": "^2.6.6",
48-
"@tiptap/extension-table": "^2.6.6",
49-
"@tiptap/extension-table-cell": "^2.6.6",
50-
"@tiptap/extension-table-header": "^2.6.6",
51-
"@tiptap/extension-table-row": "^2.6.6",
52-
"@tiptap/extension-task-item": "^2.6.6",
53-
"@tiptap/extension-task-list": "^2.6.6",
54-
"@tiptap/extension-text-align": "^2.6.6",
55-
"@tiptap/extension-text-style": "^2.6.6",
56-
"@tiptap/pm": "^2.6.6",
57-
"@tiptap/react": "^2.6.6",
58-
"@tiptap/starter-kit": "^2.6.6",
59-
"@types/three": "^0.168.0",
60-
"autoprefixer": "^10.4.20",
61-
"axios": "^1.7.7",
62-
"caniuse-lite": "^1.0.30001660",
63-
"cheerio": "^1.0.0",
64-
"chroma-js": "^3.1.1",
65-
"class-variance-authority": "^0.7.0",
66-
"clsx": "^2.1.1",
67-
"doc-detective": "^2.16.7",
68-
"docusaurus-plugin-openapi-docs": "^4.0.1",
69-
"docusaurus-plugin-sass": "^0.2.2",
70-
"docusaurus-theme-openapi-docs": "^4.0.1",
71-
"embla-carousel-react": "^8.2.1",
72-
"framer-motion": "^11.8.0",
73-
"highlight.js": "^11.10.0",
74-
"js-yaml": "^4.1.0",
75-
"json-beautify": "^1.1.1",
76-
"jsonic": "^1.0.1",
77-
"lowlight": "^3.1.0",
78-
"lucide-react": "^0.441.0",
79-
"marked": "^14.1.2",
80-
"mini-svg-data-uri": "^1.4.4",
81-
"postcss": "^8.4.45",
82-
"postcss-import": "^16.1.0",
83-
"posthog-docusaurus": "^2.0.1",
84-
"prism-react-renderer": "^2.4.0",
85-
"prosemirror-history": "^1.4.1",
86-
"react": "^18.3.1",
87-
"react-dom": "^18.3.1",
88-
"react-monaco-editor": "^0.56.1",
89-
"react-resizable": "^3.0.5",
90-
"react-router-dom": "^6.26.2",
91-
"react-transition-group": "^4.4.5",
92-
"rehype-react": "^8.0.0",
93-
"rehype-sanitize": "^6.0.0",
94-
"remark": "^15.0.1",
95-
"remark-parse": "^11.0.0",
96-
"remark-react": "^9.0.1",
97-
"remark-rehype": "^11.1.0",
98-
"sass": "^1.78.0",
99-
"sharp": "^0.33.5",
100-
"simplex-noise": "^4.0.3",
101-
"tailwind-merge": "^2.5.2",
102-
"tailwindcss": "^3.4.11",
103-
"tailwindcss-animate": "^1.0.7",
104-
"three": "^0.168.0",
105-
"tiptap": "^1.32.2",
106-
"unified": "^11.0.5"
107-
},
108-
"devDependencies": {
109-
"@docusaurus/module-type-aliases": "^3.5.2",
110-
"@tsconfig/docusaurus": "^2.0.3",
111-
"typescript": "^5.6.2"
112-
},
113-
"browserslist": {
114-
"production": [
115-
">0.5%",
116-
"not dead",
117-
"not op_mini all"
118-
],
119-
"development": [
120-
"last 1 chrome version",
121-
"last 1 firefox version",
122-
"last 1 safari version"
123-
]
124-
},
125-
"engines": {
126-
"node": ">=18.0"
127-
}
128-
}
1+
# Dev-Docs VSCode Extension
2+
3+
Dev-Docs is a powerful VSCode extension designed to streamline the process of creating and managing documentation for your projects. It offers a wide range of features to help developers generate, organize, and maintain both internal and external documentation.
4+
5+
## Key Features
6+
7+
1. **Automatic Documentation Generation**: Generates documentation for your code files, including functions, classes, and methods.
8+
2. **Context-Aware Documentation**: Creates high-level context documentation for files and folders.
9+
3. **API Documentation**: Automatically generates API documentation and Postman collections.
10+
4. **External Documentation Support**: Facilitates the creation and management of external-facing documentation.
11+
5. **Search Functionality**: Allows you to search through your documentation easily.
12+
6. **Version Control Integration**: Integrates with Git for documentation version control.
13+
7. **Customizable AI-Powered Documentation**: Uses AI to generate documentation based on customizable prompts and filters.
14+
15+
## Getting Started
16+
17+
1. Install the Dev-Docs extension from the VSCode marketplace.
18+
2. Sign in to Dev-Docs using your GitHub account by running the `devdocs.getGitHubUser` command.
19+
3. Initialize Dev-Docs in your project by running the `devdocs.versionControl` command.
20+
4. Start generating documentation using various commands like `devdocs.generateDocumentation` or `devdocs.generateAPIDocumentation`.
21+
22+
## Commands
23+
24+
- `devdocs.helloWorld`: Open the main Dev-Docs interface
25+
- `devdocs.generateDocumentation`: Generate documentation for the current file
26+
- `devdocs.generateAPIDocumentation`: Generate API documentation
27+
- `devdocs.generateContext`: Generate high-level context for the current file
28+
- `devdocs.generateMultiContext`: Generate context for multiple files
29+
- `devdocs.generateExternalDocs`: Generate external-facing documentation
30+
- `devdocs.search`: Search through your documentation
31+
- `devdocs.auditDocs`: Audit your documentation for improvements
32+
33+
## Configuration
34+
35+
You can customize Dev-Docs behavior by modifying the `dev-docs.json` file in your project root. This file allows you to set various options such as:
36+
37+
- `ai.internalTypeFilters`: Specify which code elements to document
38+
- `ai.codeFilters`: Filter code based on specific criteria
39+
- `ai.nameFilters`: Filter elements by name
40+
- `ai.docSubFolder`: Specify a subfolder for documentation
41+
- `ai.branch`: Set a specific branch for documentation commits
42+
43+
## Contributing
44+
45+
To contribute to the Dev-Docs extension, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file in the repository.
46+
47+
For more detailed information and advanced usage, please refer to the [official Dev-Docs documentation](https://dev-docs.dev/docs).

0 commit comments

Comments
 (0)