Skip to content

Commit

Permalink
Squashed 'extensions/src/quick-verse/' changes from 01213e7e2..8bc6203ad
Browse files Browse the repository at this point in the history
8bc6203ad update dependencies (#80)
0dbceff41 Clarify readme uncommenting directions (#79)
682f7eaca Clarify readme uncommenting directions
fce064477 Bump webpack from 5.91.0 to 5.94.0 (#78)
ccbc2d120 Removed outdated change description line, add comment template info section and instructions to avoid merge conflicts (#77)
017901425 Removed outdated change description line, add comment template info section and instructions to avoid merge conflicts
8d7fc6f86 #481: Changed a couple places in files where we descriptions that refer to Paranext (#75)

git-subtree-dir: extensions/src/quick-verse
git-subtree-split: 8bc6203ad10c5750e163c8eab02e12ff383862c0
  • Loading branch information
irahopkinson committed Oct 3, 2024
1 parent e1c006e commit 1a8872c
Show file tree
Hide file tree
Showing 5 changed files with 1,615 additions and 1,188 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Basic extension template for Platform.Bible

<!-- <!-- Opening comment tag for Template Info Section. Ignore this for now. More info in [Hide Template Info](#hide-template-info). -->

## Template Info

This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs. Note that the `*.web-view.*` files and the `public/assets` folder mentioned in [Summary](#summary) are not present in this template. For inspiration on what these could look like, refer to any extension that is built using this template. An example would be the [Text Collection extension](https://github.com/paranext/paranext-extension-text-collection).
Expand Down Expand Up @@ -32,13 +34,11 @@ To make the process of customizing from the template as smooth as possible, we r
- In `manifest.json`:

- Replace `paranext-extension-template` with `your-extension-name` (2 occurrences)
- Replace the description with your own description
- Update ownership information and other relevant fields as desired

- In `package.json`:

- Replace `paranext-extension-template` with `your-extension-name` (2 occurrences)
- Replace the description with your own description
- Update ownership information and other relevant fields as desired

- In `assets/displayData.json`:
Expand Down Expand Up @@ -69,9 +69,13 @@ To make the process of customizing from the template as smooth as possible, we r

The `manifest.json` and `package.json` files contain information specific to your extension. Add your extension's details in these two files as needed. See more information on the `manifest.json` and `package.json` files in [Extension Anatomy](https://github.com/paranext/paranext-extension-template/wiki/Extension-Anatomy#extension-manifest).

#### Remove Template Info
#### Hide Template Info

Once finished customizing this template to be your own, you can uncomment the [HTML comment tag](https://www.w3schools.com/html/html_comments.asp) above the [Template Info](#template-info) section to hide this template-related info in this readme. You can do this by clicking on the line and doing CTRL + / in VS Code. You can also do this manually by removing the first opening '&lt;!--' and the only closing '-->' on the line. Leaving this info commented in your readme will hide it in your readme while avoiding merge conflicts if you decide to [update this extension from the template](#to-update-this-extension-from-the-template) in the future. If you never want to update this extension from the template, you can remove the [Template Info](#template-info) section and sub-sections of this readme.

Note: if you [update this extension from the template](#to-update-this-extension-from-the-template), there may be important changes in this section like additional customizations you must make to this extension. Please keep an eye out for readme changes when updating from the template.

Once finished customizing this template to be your own, you can remove the [Template Info](#template-info) section and sub-sections of this readme.
<!-- Closing comment tag for Template Info Section -->

## Summary

Expand Down
4 changes: 2 additions & 2 deletions assets/descriptions/description-en.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Extension template for Paranext. Powered by webpack.
Extension template for Platform.Bible. Powered by webpack.

This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs.
This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs.
2 changes: 1 addition & 1 deletion assets/displayData.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"localizedDisplayInfo": {
"en": {
"displayName": "Paranext Extension Template",
"shortSummary": "Base template for a Paranext Extension",
"shortSummary": "Base template for a Platform.Bible Extension",
"description": "assets/descriptions/description-en.md"
}
}
Expand Down
Loading

0 comments on commit 1a8872c

Please sign in to comment.