mirror of
https://github.com/kha7iq/pingme.git
synced 2025-05-21 01:00:15 -07:00
docs: updated docs
This commit is contained in:
parent
02a560f842
commit
5d0e6efc40
@ -11,6 +11,26 @@ possible.
|
|||||||
- `cmd/rocketchat` - RocketChat notification service.
|
- `cmd/rocketchat` - RocketChat notification service.
|
||||||
- `cmd/slack` - Slack notification service.
|
- `cmd/slack` - Slack notification service.
|
||||||
- `cmd/telegram` - Telegram notification service
|
- `cmd/telegram` - Telegram notification service
|
||||||
|
|
||||||
|
- Documentation
|
||||||
|
`docs` - Contains the documentation in markdown format.
|
||||||
|
- `services.md` If you are adding a new service please add documentaiton to `services.md`.
|
||||||
|
- `home.md` Is the main page rendered when docs website is loaded.
|
||||||
|
- `install.md` Contains the install instructions for different packages.
|
||||||
|
|
||||||
|
- Checking Locally
|
||||||
|
- Docsify is used for documentation rendering from markdown, you can download
|
||||||
|
the cli and test locally before opening a pull request.
|
||||||
|
Install
|
||||||
|
```bash
|
||||||
|
npm i docsify-cli -g
|
||||||
|
# yarn global add docsify-cli
|
||||||
|
```
|
||||||
|
Serve locally
|
||||||
|
```bash
|
||||||
|
docsify serve docs
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Commits
|
## Commits
|
||||||
|
|
||||||
|
@ -25,7 +25,7 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="#about">About</a> •
|
<a href="#about">About</a> •
|
||||||
<a href="https://kha7iq.github.io/docs-pingme/#/">Documentation</a> •
|
<a href="https://kha7iq.github.io/pingme">Documentation</a> •
|
||||||
<a href="#supported-services">Supported Services</a> •
|
<a href="#supported-services">Supported Services</a> •
|
||||||
<a href="#install">Install</a> •
|
<a href="#install">Install</a> •
|
||||||
<a href="#github-action">Github Action</a> •
|
<a href="#github-action">Github Action</a> •
|
||||||
@ -138,14 +138,14 @@ GLOBAL OPTIONS:
|
|||||||
--help, -h show help (default: false)
|
--help, -h show help (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
Check [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.
|
Check [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
All the flags have corresponding environment variables associated with it. You can either provide the value with flags
|
All the flags have corresponding environment variables associated with it. You can either provide the value with flags
|
||||||
or export to a variable.
|
or export to a variable.
|
||||||
|
|
||||||
View the [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.
|
View the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
Loading…
x
Reference in New Issue
Block a user