Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 3.2 KB

README.md

File metadata and controls

55 lines (36 loc) · 3.2 KB
Raw

Extension Template

Quick start and create a new extension by using this template. Follow the below 4 steps:

Refer this link for detailed extension docs after following the below steps:

step 1

Login with github: https://github.com/login

step 2

Create a new repository using this template. New extension from template

step 3

  • Clone your GitHub Repo created from step 2. See this link to lean how to clone a repository from GitHub.
  • Edit package.json file in template, make sure to update the following fields accordingly:
Field Description
title Replace "Name of the extension" with the actual title of your extension.
name Change github-<owner>-<repo> to your specific package name, formatted as github-yourusername-reponame.
description Update to a brief, relevant description of what your extension does.
version Start with "0.0.1" or update to reflect your current version following semantic versioning.
license Confirm "MIT" is suitable or specify another license if necessary.
author Replace with your name and a link to your GitHub profile or another URL.
homepage Set to the URL of your project’s homepage or GitHub repository.
engines Ensure compatibility with the required Brackets version, e.g., ">=3.0.0".
categories Update "demo" with relevant categories that fit your extension.
keywords Update or append additional keywords that describe your extension.
files Ensure this includes all necessary files and folders for your extension.

step 4

  • Go to https://create.phcode.dev .This is a special development centric website of phcode.dev which shows non minified js/css files in the browser developer tools.
  • Open the cloned folder and select Debug > Load Project As Extension

image

  • You can now make code changes to your extension and select Debug> Reload With Extensions to test the new code changes.
  • When you are done developing the extension/theme, select Debug> Unload Project As Extension to unload the extension.

image

Detailed Documentation

Please go to https://github.com/phcode-dev/phoenix/wiki/How-To-Write-Extensions-And-Themes for more documentation/community support links.

Publishing your extension to the repository

Once you have built your extension/theme, you can publish the extension to phcode.dev extension repository in a single step directly from this repo. Please see publish section in this link for more details: https://github.com/phcode-dev/phoenix/wiki/How-To-Write-Extensions-And-Themes