standardnotes/standardnotes-extensions1
1
0
Fork 0
mirror of https://github.com/benjaminjacobreji/standardnotes-extensions.git synced 2026-02-03 02:44:00 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Benjamin Jacob Reji
2021-01-10 12:58:20 +04:00
committed by GitHub
parent 6f7b080a62
commit c8acbf5d40
1 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -2,11 +2,41 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/25256400-19de-4a55-a026-3d8ced3bf9b7/deploy-status)](https://app.netlify.com/sites/standardnotes-extensions/deploys)
## Usage
### Option 1: Use default URL
Use ```https://standardnotes-extensions.netlify.app/index.json``` as an *Extended Code* in Standard-Notes.
## Extensions (Needs Attention)
### Option 2: Fork & Use custom URL (with [Netlify](https://app.netlify.com/))
1. extensions/autocomplete-tags.toml -> standardnotes/quick-tags
1. Fork this repo [benjaminjacobreji/standardnotes-extensions](https://github.com/benjaminjacobreji/standardnotes-extensions/fork)
2. Sign-in/ Sign-up into [Netlify](https://app.netlify.com/)
3. Click on [New site from Git](https://app.netlify.com/start) Button.
4. Connect to GitHub and select forked repo ```your-github-username/standardnotes-extensions```
5. Deploy site and wait for build to finish
6. (Optional) Change Site name at ```Site settings > Change site name``` on Netlify
7. After that you can use ```YOUR_SITE_URL/index.json``` as an ```Extended Code```
### Option 3: Fork & Use custom URL (without [Netlify](https://app.netlify.com/))
It's easy and recommended to host with Netlify. However if you insist not to use it, it is also possible (notice: the following steps work on Linux or WSL):
1. Prepare your environment with `Python 3.7` with `pip`, as well as `Git`;
2. Make sure Python 3.7 can be called directly via `python` from the shell;
3. Make sure Git is installed and can be called directly via `git` from the shell;
4. `pip install -r requirements.txt` to install required Python libraries;
5. Run the build script `URL=my_url python build.py` where `my_url` is the full URL you would later host the resource files on. E.g. if you want to access the plugins via `https://example.com/index.json` then replace `my_url` with `https://example.com/`.
6. Verify that:
1. the `public` directory is generated;
2. there should be `public/index.json` containing information of all extensions;
3. all extensions should exists in `public` as sub-directories;
7. Host the `public` directory like you would do with any static resources, using nginx, caddy, etc.
8. You need to enable CORS headers on your reverse proxy (nginx / caddy / traefik). With nginx these rules will be enough:
```nginx
add_header 'Access-Control-Allow-Origin' '*';
add_header 'Access-Control-Allow-Headers' 'content-type';
```
## Credits