Skip to content

Commit

Permalink
Everywhere: Moved wiki to mkdocs
Browse files Browse the repository at this point in the history
Even though the integrated repository wiki from github is nice, it doesn't allow for managing contributions
through pull requests and issues. Because of that, I've decided to migrate the wiki to mkdocs.

Most of the code came from https://github.com/codeoverflow-org/nodecg-io-docs as they already have
a github actions setup in place as well as do not use google fonts.
  • Loading branch information
networkException committed Jan 30, 2021
1 parent b12887b commit 764e8cb
Show file tree
Hide file tree
Showing 34 changed files with 2,084 additions and 1 deletion.
19 changes: 19 additions & 0 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Publish docs via GitHub Pages
on:
push:
branches:
- master

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout master
uses: actions/checkout@v1

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CUSTOM_DOMAIN: wiki.t2linux.org
12 changes: 12 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Linter
on: pull_request
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: xt0rted/markdownlint-problem-matcher@v1
- name: "Run Markdown linter"
uses: docker://avtodev/markdown-lint:v1
with:
args: docs/**/*.md
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# mkdocs
build/
17 changes: 17 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"default": true,
"MD003": { "style": "atx" },
"MD007": { "indent": 4 },
"MD012": false,
"MD013": false,
"MD026": false,
"MD033": false,
"MD034": false,
"MD036": false,
"MD040": false,
"MD041": false,
"MD046": { "style": "fenced" },
"MD047": false,
"no-hard-tabs": true,
"whitespace": false
}
18 changes: 18 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"arrowParens": "always",
"bracketSpacing": true,
"htmlWhitespaceSensitivity": "css",
"insertPragma": false,
"jsxBracketSameLine": false,
"jsxSingleQuote": false,
"printWidth": 120,
"proseWrap": "preserve",
"quoteProps": "as-needed",
"requirePragma": false,
"semi": true,
"singleQuote": false,
"tabWidth": 4,
"trailingComma": "es5",
"useTabs": false,
"vueIndentScriptAndStyle": false
}
Loading

0 comments on commit 764e8cb

Please sign in to comment.