Skip to content

Commit 00670ff

Browse files
jasonplattsgitbook-bot
authored andcommitted
GitBook: [#14] Added content to documentation.
1 parent 08124b7 commit 00670ff

File tree

4 files changed

+32
-7
lines changed

4 files changed

+32
-7
lines changed

.gitbook/assets/file.drawing.svg

+3-3
Loading

SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,5 @@
2323

2424
***
2525

26+
* [Best Practices](best-practices.md)
2627
* [FAQ](faq.md)

best-practices.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Best Practices
2+
+26-4
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,44 @@
11
---
2-
description: Create a new extension project and become familiar with its file structure.
2+
description: Create a new extension project and become familiar with its structure.
33
---
44

55
# Creating an Extension
66

77
## System Requirements
88

9+
Before creating an extension make sure the following requirements are met.
10+
11+
* You have [Node.js](https://nodejs.org/en/) 16.10 or higher installed.
12+
* You have [Git](https://git-scm.com) installed.
13+
914
## Starting a New Extension
1015

16+
CodeEdit makes it easy to create a new extension project using the **Extensions** menu. To get started choose **Extensions > New Extension…**, which will open a Save dialog prompting you to select a location for your project.
17+
18+
{% hint style="info" %}
19+
**Extension Developer Account**
20+
21+
It is not necessary to have a CodeEdit developers account if you have no intention of offering the extension on the Extension Store. However, an account is required to publish an extension and make it publicly available. See [Publishing an Extension](publishing-an-extension.md) for more information.
22+
{% endhint %}
23+
1124
## File and Folder Structure
1225

1326
```
1427
.
15-
├── .gitignore
16-
├── README.md
28+
├── assets/
29+
│ └── icon.png
30+
├── node_modules/
31+
│ └── ...
1732
├── src/
1833
│ └── main.js
19-
└── manifest.json
34+
├── .gitignore
35+
├── CHANGELOG.md
36+
├── manifest.json
37+
└── README.md
2038
```
2139

40+
41+
2242
## Manifest File
43+
44+
## Extension Entrypoint

0 commit comments

Comments
 (0)