Skip to content

Commit 60d10e2

Browse files
kosalapererakosalaperera
committed
feat(*): initial commit
0 parents  commit 60d10e2

15 files changed

+600
-0
lines changed

‎.gitignore

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
#
2+
# Project Specific Ignores
3+
#
4+
5+
6+
#
7+
# VS Code Ignores
8+
#
9+
.vscode/*
10+
!.vscode/settings.json
11+
!.vscode/tasks.json
12+
!.vscode/launch.json
13+
!.vscode/extensions.json
14+
*.code-workspace
15+
16+
# Local History for Visual Studio Code
17+
.history/
18+
19+
20+
#
21+
# macOS Ignores
22+
#
23+
24+
# General
25+
.DS_Store
26+
.AppleDouble
27+
.LSOverride
28+
29+
# Icon must end with two \r
30+
Icon
31+
32+
# Thumbnails
33+
._*
34+
35+
# Files that might appear in the root of a volume
36+
.DocumentRevisions-V100
37+
.fseventsd
38+
.Spotlight-V100
39+
.TemporaryItems
40+
.Trashes
41+
.VolumeIcon.icns
42+
.com.apple.timemachine.donotpresent
43+
44+
# Directories potentially created on remote AFP share
45+
.AppleDB
46+
.AppleDesktop
47+
Network Trash Folder
48+
Temporary Items
49+
.apdisk
50+
51+
52+
#
53+
# Windows Ignores
54+
#
55+
56+
# Windows thumbnail cache files
57+
Thumbs.db
58+
Thumbs.db:encryptable
59+
ehthumbs.db
60+
ehthumbs_vista.db
61+
62+
# Dump file
63+
*.stackdump
64+
65+
# Folder config file
66+
[Dd]esktop.ini
67+
68+
# Recycle Bin used on file shares
69+
$RECYCLE.BIN/
70+
71+
# Windows Installer files
72+
*.cab
73+
*.msi
74+
*.msix
75+
*.msm
76+
*.msp
77+
78+
# Windows shortcuts
79+
*.lnk

‎CODE_OF_CONDUCT.md

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[email protected].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121+
122+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123+
enforcement ladder](https://github.com/mozilla/diversity).
124+
125+
[homepage]: https://www.contributor-covenant.org
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
https://www.contributor-covenant.org/faq. Translations are available at
129+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing
2+
3+
> We use our wonderful [Contributor Covenant](http://contributor-covenant.org/) for our [Contributor Code of Conduct](CODE_OF_CONDUCT.md). This same template is used by [over 350,000 open source projects](https://github.com/search?l=Markdown&q=%22Contributor+Covenant%22+fork%3Afalse&type=Code). Please read that before you join our project.
4+
5+
Welcome! And thank you for your interest in contributing to the template. There are many ways in which you can contribute, beyond writing code. Here's a high-level overview of how you can get involved:
6+
7+
- Ask questions and problems on [Stack Overflow]()
8+
- [Submit bugs and feature requests](https://github.com/alertbox/gh-minimalist/issues), and help us verify as they are checked in
9+
- Upvote [popular feature requests]()
10+
- Review [source code changes](https://github.com/alertbox/gh-minimalist/pulls)
11+
- Review the [documentation](docs) and make pull requests for anything from typos to new content
12+
13+
## Contributing to Source Code
14+
15+
If you are interested in writing code to fix issues, here's a high-level overview of how you can clone the repository and get started.
16+
17+
### Prerequisites
18+
19+
In order to download necessary tools, clone the repo, and install, you need internet access.
20+
21+
You'll need following tools:
22+
23+
- Git
24+
- VS Code
25+
- Docker Desktop
26+
- Docker Extension for VS Code
27+
28+
### Build and Run
29+
30+
If you want to understand how the source code works, or debug an issue, you'll want to get the source, build it, and run it locally.
31+
32+
#### Getting the source code
33+
34+
First, fork the repository so that you can make a Pull Request. Then clone your fork locally:
35+
36+
```bash
37+
#!/bin/bash
38+
git clone https://github.com/<your-github-account>/gh-minimalist
39+
```
40+
41+
Occasionally you would want to merge changes the upstream repository (the official code repo) with your fork.
42+
43+
```bash
44+
#!/bin/bash
45+
cd gh-minimalist
46+
git checkout master
47+
git pull https://github.com/alertbox/gh-minimalist master
48+
```
49+
50+
#### Build and run from the source
51+
52+
First, you want to ensure Docker Desktop is running on your machine so that the Docker Image `alertbox/docsify-served` able to pull from the [Docker Hub repository]().
53+
54+
```bash
55+
#!/bin/bash
56+
cd gh-minimalist
57+
docker run -dp 8020:3000 -v `pwd`/docs:/var/www alertbox/docsify-served
58+
59+
# Or
60+
cd gh-minimalist && docker-compose up -d
61+
```
62+
63+
To test the changes, you launch your favorite browser and visit [https://localhost:8020](https://localhost:8020).
64+
65+
### Pull Requests
66+
67+
To enable us to quickly review and accept your pull request, always create one pull request per issue, link the issue in the pull request. Never merge multiple into one unless they all share the same root cause.
68+
69+
Be sure to follow community guidelines and keep the source code changes as small as possible. Avoid any pure document formatting changes to code that has not been modified otherwise.
70+
71+
To avoid multiple pull requests resolving the same issue, let others know you are working on it by saying so in a comment.
72+
73+
### Publishing
74+
75+
At present, the template published via GitHub Pages and only have to do a minimal amount of work to update the hosted version. To get familiar, check out [GitHub Pages guide]().
76+
77+
### Discussion Etiquette
78+
79+
In order to keep the conversations clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times.
80+
81+
### Thank You
82+
83+
Your contributions to OSS projects, large or small, make great projects like possible. Thank you for taking time to contribute.

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Alertbox Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# GitHub Minimalist
2+
3+
[![docsify](https://img.shields.io/badge/maintained%20with-docsify-cc00ff.svg)](https://docsify.js.org/)
4+
![GitHub repo size](https://img.shields.io/github/repo-size/alertbox/gh-minimalist)
5+
![GitHub top language](https://img.shields.io/github/languages/top/alertbox/gh-minimalist)
6+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
7+
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/alertbox/gh-minimalist)
8+
9+
A template repository to get started with Docsify. Find out more at [docsify.js.org](https://docsify.js.org).
10+
11+
<p align="center">
12+
<img alt="The gh-minimalist in action" src="https://user-images.githubusercontent.com/958227/84028138-d4a15280-a9ad-11ea-93d1-43ebace761b3.png" width="1024">
13+
</p>
14+
15+
> the gh-minimalist template markdown in action.
16+
17+
## Contents
18+
19+
- [Requirements](#requirements)
20+
- [Use the Template](#use-the-template)
21+
- [Feedback](#feedback)
22+
- [Contributing](#contributing)
23+
- [License](#license)
24+
25+
## Requirements
26+
27+
The GitHub Minimalist works with:
28+
29+
- [Docsify latest](https://docsify.js.org/#/cdn?id=latest-version), the magical documentation site generator
30+
- [Markdown](https://guides.github.com/features/mastering-markdown/), the lightweight and easy-to-use syntax for all forms of writing on GitHub platform
31+
32+
You will want to see the [hosted version](https://alertbox.github.io/gh-minimalist/) to have a feel of the most basic level.
33+
34+
## Use the Template
35+
36+
Check out the [quick start guide](https://alertbox.github.io/gh-minimalist/#/quick-start).
37+
38+
## Feedback
39+
40+
We would love for you to give all sorts of feedback. Here are the ways you can [provide feedback](http://alertbox.github.io/gh-minimalist/#/?id=feedback)
41+
42+
## Contributing
43+
44+
There are many ways in which you can participate in the project. Please see the document [How to Contribute](CONTRIBUTING.md).
45+
46+
## License
47+
48+
Copyright (c) Alertbox Inc. All rights reserved.
49+
50+
The source code is license under the [MIT License](LICENSE).

‎docker-compose.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: "3.8"
2+
3+
services:
4+
5+
gh-minimalist:
6+
image: alertbox/docsify-served
7+
ports:
8+
- 8020:3000/tcp
9+
volumes:
10+
- ${PWD}/docs:/var/www

‎docs/.nojekyll

Whitespace-only changes.

0 commit comments

Comments
 (0)