Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document basic file structure #102

Merged
merged 1 commit into from
Oct 22, 2021
Merged

Document basic file structure #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,24 @@ Abstract: [Placeholder] Abstract.
Markup Shorthands: markdown yes
</pre>

# File structure

Once unpacked from the distribution format, a WebExtension is a directory containing a number of files.

Note: In some operating systems, filenames are case insensitive. This can lead to naming collisions.

## manifest.json

A <a href="#manifest">Manifest</a> file.

## _locales subdirectory

An optional directory containing strings as defined in <a href="#localization">localization</a>.

## Other files

An extension may also contain other files, such as those referenced in the <a href="#key-content_scripts">content_scripts</a> and <a href="#key-background">background</a> part of the <a href="#manifest">Manifest</a>.

# Manifest

A WebExtension must have a manifest file at its root directory.
Expand Down Expand Up @@ -196,3 +214,9 @@ This key may be present.
### Key `web_accessible_resources`

This key may be present.

# Localization

The _locales subdirectory of a WebExtension can contain strings for internationalization purposes.

Issue(62): Specify localization handling.