forked from Paperback-iOS/website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 7ed42ab
Showing
28 changed files
with
16,319 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
root = true | ||
|
||
[*] | ||
indent_style = tab | ||
indent_size = 4 | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.yml] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es6": true | ||
}, | ||
"extends": [ | ||
"plugin:vue/essential", | ||
"vuepress", | ||
"prettier" | ||
], | ||
"parserOptions": { | ||
"ecmaVersion": 2018, | ||
"sourceType": "module" | ||
}, | ||
"plugins": [ | ||
"vue", | ||
"prettier" | ||
], | ||
"rules": { | ||
"prettier/prettier": ["error"] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# These are supported funding model platforms | ||
|
||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] | ||
patreon: FaizanDurrani | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: # Replace with a single Ko-fi username | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: Build and deploy website | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v1 | ||
|
||
- name: Install Node v12 | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: 12 | ||
|
||
- name: Build website | ||
run: | | ||
npm install | ||
npm run build | ||
- name: Add noJekyll | ||
run: touch ./public/.nojekyll | ||
|
||
- name: Deploy website | ||
uses: peaceiris/[email protected] | ||
env: | ||
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }} | ||
PUBLISH_BRANCH: gh-pages | ||
PUBLISH_DIR: ./public | ||
with: | ||
username: 'github-actions[bot]' | ||
useremail: 'github-actions[bot]@users.noreply.github.com' | ||
commitMessage: ${{ github.event.head_commit.message }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# OS generated files # | ||
###################### | ||
.DS_Store | ||
.DS_Store? | ||
._* | ||
.Spotlight-V100 | ||
.Trashes | ||
ehthumbs.db | ||
Thumbs.db | ||
|
||
# Node | ||
node_modules/ | ||
npm-debug.log | ||
|
||
# Compiled site | ||
/public/ | ||
|
||
# Ignore Visual Studio Code files | ||
*.code-workspace | ||
.vscode/launch.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"tabWidth": 4, | ||
"useTabs": true, | ||
"trailingComma": "es5", | ||
"bracketSpacing": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
{ | ||
"blocks": false, | ||
"brackets": "never", | ||
"colons": "never", | ||
"colors": "always", | ||
"commaSpace": "always", | ||
"commentSpace": "always", | ||
"cssLiteral": "never", | ||
"customProperties": [], | ||
"depthLimit": false, | ||
"duplicates": true, | ||
"efficient": "always", | ||
"exclude": [], | ||
"extendPref": "@extends", | ||
"globalDupe": true, | ||
"groupOutputByFile": true, | ||
"indentPref": false, | ||
"leadingZero": "always", | ||
"maxErrors": false, | ||
"maxWarnings": false, | ||
"mixed": true, | ||
"mixins": [], | ||
"namingConvention": false, | ||
"namingConventionStrict": false, | ||
"none": "always", | ||
"noImportant": false, | ||
"parenSpace": "never", | ||
"placeholders": "always", | ||
"prefixVarsWithDollar": "always", | ||
"quotePref": false, | ||
"reporterOptions": { | ||
"columns": ["lineData", "severity", "description", "rule"], | ||
"columnSplitter": " ", | ||
"showHeaders": false, | ||
"truncate": true | ||
}, | ||
"semicolons": "never", | ||
"sortOrder": ["grouped", "alphabetical"], | ||
"stackedProperties": "never", | ||
"trailingWhitespace": "never", | ||
"universal": false, | ||
"valid": true, | ||
"zeroUnits": "never", | ||
"zIndexNormalize": false, | ||
"stylusSupremacy.selectorSeparator": ",\n", | ||
"stylusSupremacy.insertNewLineAroundBlocks": "root" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
The MIT License | ||
|
||
Copyright (c) 2010-2020 Google, Inc. http://angularjs.org | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Paperback | ||
|
||
## Help contribute to the website | ||
|
||
### Edit existing pages | ||
Editing existing pages is very easy, just go to it on the website then press the "Help us improve this page" link in the bottom left of it. | ||
I recommend previewing the code in using the [markdown-it live editor](https://markdown-it.github.io/) as they're functionally similiar. | ||
|
||
### Adding new pages | ||
Pretty much just keep the current structure, preferably don't add anything under FAQ, just edit the README.md for that. If you're adding new guides then go to [nav.js](https://github.com/FaizanDurrani/Paperback/blob/master/src/.vuepress/config/nav.js) and edit it in, follow the current example of `Getting started`, shouldn't be too hard. | ||
|
||
### Building local enviroment | ||
Pretty much just fork the repo, clone it to your computer then do a `npm install` then `vuepress dev src`/`npm run serve`. | ||
|
||
### Support | ||
Contact Soitora#0001 on Discord for support. |
Oops, something went wrong.