Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zce/pages-store
GitHub Pages Storage Adapter for Ghost
https://github.com/zce/pages-store
Last synced: about 2 months ago
JSON representation
GitHub Pages Storage Adapter for Ghost
- Host: GitHub
- URL: https://github.com/zce/pages-store
- Owner: zce
- License: mit
- Created: 2018-01-11T05:59:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-11T04:39:28.000Z (about 1 year ago)
- Last Synced: 2024-07-12T22:55:07.935Z (2 months ago)
- Language: JavaScript
- Size: 203 KB
- Stars: 10
- Watchers: 3
- Forks: 5
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pages-store
[![NPM Downloads][downloads-image]][downloads-url]
[![NPM Version][version-image]][version-url]
[![License][license-image]][license-url]
[![Dependency Status][dependency-image]][dependency-url]
[![devDependency Status][devdependency-image]][devdependency-url]
[![Code Style][style-image]][style-url]
> GitHub Pages Storage Adapter for Ghost
## Installation
### Via Yarn or NPM
- Install pages-store module
```shell
yarn add pages-store
# or npm
npm install pages-store
```
- Make the storage folder if it doesn't exist yet
```shell
mkdir -p content/adapters/storage
```
- Copy the module into the right location
```shell
cp -vR node_modules/pages-store content/adapters/storage/pages-store
```
### Via Git
In order to replace the storage module, the basic requirements are:
- Create a new folder inside `content/adapters` called `storage`
- Clone this repo to `storage`
```shell
cd [path/to/ghost]/content/adapters/storage
git clone https://github.com/zce/pages-store.git
```
- Install dependencies
```shell
cd pages-store
yarn
# or
npm install
```
## Usage
In your `config.[env].json` file, you'll need to add a new `storage` block to whichever environment you want to change:
```json
{
"storage": {
"active": "pages-store",
"pages-store": {
"prefix": "http://zce.github.io/storage",
"repo": "zce/storage"
}
}
}
```
### Options
```json
{
"storage": {
"active": "pages-store",
"pages-store": {
"repo": "https://git.coding.net/zce/images.git",
"branch": "master",
"prefix": "https://img.zce.me",
"format": "{yyyy}/{mm}/{dd}/{name}-{uuid}-{timestamp}-{random}{ext}"
}
}
}
```
### Authorization
You can use URL authentication:
- GitHub: `https://@github.com/zce/images.git`
- GitLab/Coding: `https://:@git.coding.net/zce/images.git`
> depends on the service.
## Contributing
1. **Fork** it on GitHub!
2. **Clone** the fork to your own machine.
3. **Checkout** your feature branch: `git checkout -b my-awesome-feature`
4. **Commit** your changes to your own branch: `git commit -am 'Add some feature'`
5. **Push** your work back up to your fork: `git push -u origin my-awesome-feature`
6. Submit a **Pull Request** so that we can review your changes.
> **NOTE**: Be sure to merge the latest from "upstream" before making a pull request!
## Related
- [zce/qiniu-store](https://github.com/zce/qiniu-store) - Qiniu Storage for Ghost
## License
[MIT](LICENSE) © [汪磊](https://zce.me/)
[downloads-image]: https://img.shields.io/npm/dm/pages-store.svg
[downloads-url]: https://npmjs.org/package/pages-store
[version-image]: https://img.shields.io/npm/v/pages-store.svg
[version-url]: https://npmjs.org/package/pages-store
[license-image]: https://img.shields.io/npm/l/pages-store.svg
[license-url]: https://github.com/zce/pages-store/blob/master/LICENSE
[dependency-image]: https://img.shields.io/david/zce/pages-store.svg
[dependency-url]: https://david-dm.org/zce/pages-store
[devdependency-image]: https://img.shields.io/david/dev/zce/pages-store.svg
[devdependency-url]: https://david-dm.org/zce/pages-store?type=dev
[style-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[style-url]: http://standardjs.com